Updated documentation.

[RyanPaiva56]

Added TOC. Removed 1.x trait reference in 2.x docs. Added section/link to the upgrade guide.

Summary by CodeRabbit

• Documentation
  • Improved the README with a detailed table of contents, including new nested sections.
  • Added an "Upgrading from 1.x to 2.x" section with a link to upgrade instructions.
  • Updated example model code by removing a trait from the usage list.

[coderabbitai]

📝 Walkthrough

Walkthrough

The README.md file was updated to improve its structure and content. A detailed table of contents was added, including new nested sections for "Interaction with the database" and "Limitations." An "Upgrading from 1.x to 2.x" section was introduced, directing users to an external UPGRADING.md file for upgrade instructions. Additionally, the example model code for the "Port" class was modified to remove the usage of the HasPostgisColumns trait.

Changes

File(s)	Change Summary
README.md	Added a detailed table of contents with nested sections, a new upgrade section, and updated the Port class example by removing the HasPostgisColumns trait.

Poem

In README fields where details grow,
New sections bloom, their headers show.
A table of contents, neat and clear,
Upgrade paths for all to steer.
The Port trait trimmed, a lighter load—
Documentation’s brighter road!
🐇✨

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 6e18885 and 95b1d08.

📒 Files selected for processing (1)

• README.md (2 hunks)

🔇 Additional comments (2)

README.md (2)

22-51: New Table of Contents improves navigation
The detailed TOC you’ve added greatly enhances readability by surfacing both top‑level and nested sections. The links appear to match existing headings and are correctly ordered.

---

101-104: Added “Upgrading from 1.x to 2.x” section
This new section cleanly directs users to the UPGRADING.md guide. Placing it between Installation and What’s included feels logical and complete.

---

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[studnitz]

Thank you!