Docs: add ToC

[katspaugh]

Short description

Resolves #3677

Implementation details

Add a table of contents for the readme.

Summary by CodeRabbit

• New Features

  • Introduced a "Table of contents" section in the README for improved navigation.

• Documentation

  • Renamed and reorganized the section on upgrading from version 6 to version 7, emphasizing key improvements and changes.
  • Updated information regarding the removal and replacement of plugins for clarity.

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

The pull request focuses on improving the README.md documentation by adding a new "Table of contents" section and reorganizing the content related to version 7 upgrades. The changes aim to enhance navigation and provide clearer guidance for users transitioning from version 6 to version 7 of the project. The documentation now includes a structured overview of key sections and clarifies changes in plugins, options, and methods.

Changes

File	Changes
README.md	- Added new "Table of contents" section - Renamed "v7 – a new TypeScript version" to "Upgrading from v6 to v7" - Reorganized content about version 7 upgrades - Updated information about plugins and API changes

Assessment against linked issues

Objective	Addressed	Explanation
Add table of contents to improve documentation [#3677]	✅
Clarify plugin installation methods	❓	Partial improvement, but specific installation details for frameworks not fully addressed

Poem

🐰 A rabbit's guide to docs so neat,
Table of contents, a navigational treat!
From v6 to v7, we hop and we leap,
Clarity and structure, no longer asleep.
Documentation now shines, crisp and bright! 📖✨

---

📜 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 e1dabf2 and 46e437d.

📒 Files selected for processing (1)

• README.md (2 hunks)

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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. (Beta)
• @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.