Make the titles in TOC just a tad cleaner

[edgarcerecerez]

for the TOC headings, how do you feel about removing "with CodeRabbit"?

So Get Started with CodeRabbit becomes Get Started

Add CodeRabbit to your repository becomes Add to your repository

All of this is with the assumption the user will know we are referring to CodeRabbit by virtue of where they are.

My reasoning: simplify, make the TOC easier to scan.

[linear]

ENG-1963 Make the titles in TOC just a tad cleaner

[traycerai]

Plan

Observations

I analyzed the CodeRabbit documentation repository and found the specific TOC titles mentioned in the GitHub issue. The main changes are needed in the sidebars.ts file where the navigation structure is defined. I also discovered that one of these titles appears as a heading in the quickstart documentation, which should be updated for consistency.

Approach

The task is straightforward - clean up TOC titles by removing "with CodeRabbit" and "CodeRabbit" references to make them more scannable. I'll update the sidebar labels in sidebars.ts and also update the corresponding heading in the quickstart documentation for consistency. I'll focus on the two specific examples mentioned in the issue, but also consider similar patterns for a cohesive approach.

Reasoning

I listed the repository structure to understand the Docusaurus setup, then examined the sidebars.ts file to locate the TOC configuration. I used grep search to find all instances of the specific titles mentioned in the issue, which revealed they appear in both the sidebar configuration and within documentation content. I also checked category files and the main Docusaurus config to ensure I had a complete picture of where these titles might be referenced.

Proposed File Changes

📄 sidebars.ts ^(MODIFY) 🔗

Update the TOC labels to remove "with CodeRabbit" and "CodeRabbit" references as specified in the GitHub issue:

1. Change line 34: label: "Get started with CodeRabbit" to label: "Get started"
2. Change line 40: label: "Add CodeRabbit to your repository" to label: "Add to your repository"

For consistency with the cleaner approach, also consider updating:
3. Change line 61: label: "Self-host CodeRabbit" to label: "Self-host"
4. Change line 80: label: "Configure CodeRabbit" to label: "Configure"

These changes will make the TOC more scannable and cleaner while maintaining the context that users are working within the CodeRabbit documentation site.

📄 docs/getting-started/quickstart.md ^(MODIFY) 🔗

References

• 📄 sidebars.ts ^(MODIFY)

Update the heading on line 39 for consistency with the TOC changes:

Change ## Add CodeRabbit to your repository to ## Add to your repository

This ensures the heading within the quickstart guide matches the updated TOC label in sidebars.ts and maintains consistency throughout the documentation. The context is clear since users are already within the CodeRabbit documentation.

Diagram

sequenceDiagram
    participant User as Documentation User
    participant TOC as Table of Contents
    participant Content as Documentation Content
    
    User->>TOC: Scans navigation sidebar
    Note over TOC: Cleaner, shorter labels<br/>\"Get started\" vs \"Get started with CodeRabbit\"
    TOC->>User: Easier to scan and navigate
    User->>Content: Clicks on navigation item
    Note over Content: Consistent headings<br/>match TOC labels
    Content->>User: Seamless experience with<br/>matching titles

Loading

Import In IDE

🤖 Prompt for AI Agents

I have created the following plan after thorough exploration and analysis of the codebase. Follow the below plan verbatim. Trust the files and references. Do not re-verify what's written in the plan. Explore only when absolutely necessary. First implement all the proposed file changes and then I'll review all the changes together at the end. Make sure you fix all the linting, compilation or validation issues after successful implementation of the plan.

### Observations

I analyzed the CodeRabbit documentation repository and found the specific TOC titles mentioned in the GitHub issue. The main changes are needed in the `sidebars.ts` file where the navigation structure is defined. I also discovered that one of these titles appears as a heading in the quickstart documentation, which should be updated for consistency.

### Approach

The task is straightforward - clean up TOC titles by removing "with CodeRabbit" and "CodeRabbit" references to make them more scannable. I'll update the sidebar labels in `sidebars.ts` and also update the corresponding heading in the quickstart documentation for consistency. I'll focus on the two specific examples mentioned in the issue, but also consider similar patterns for a cohesive approach.

### Reasoning

I listed the repository structure to understand the Docusaurus setup, then examined the `sidebars.ts` file to locate the TOC configuration. I used grep search to find all instances of the specific titles mentioned in the issue, which revealed they appear in both the sidebar configuration and within documentation content. I also checked category files and the main Docusaurus config to ensure I had a complete picture of where these titles might be referenced.

## Mermaid Diagram

sequenceDiagram
    participant User as Documentation User
    participant TOC as Table of Contents
    participant Content as Documentation Content
    
    User->>TOC: Scans navigation sidebar
    Note over TOC: Cleaner, shorter labels<br/>\"Get started\" vs \"Get started with CodeRabbit\"
    TOC->>User: Easier to scan and navigate
    User->>Content: Clicks on navigation item
    Note over Content: Consistent headings<br/>match TOC labels
    Content->>User: Seamless experience with<br/>matching titles

## Proposed File Changes

### sidebars.ts(MODIFY)

Update the TOC labels to remove "with CodeRabbit" and "CodeRabbit" references as specified in the GitHub issue:

1. Change line 34: `label: "Get started with CodeRabbit"` to `label: "Get started"`
2. Change line 40: `label: "Add CodeRabbit to your repository"` to `label: "Add to your repository"`

For consistency with the cleaner approach, also consider updating:
3. Change line 61: `label: "Self-host CodeRabbit"` to `label: "Self-host"`
4. Change line 80: `label: "Configure CodeRabbit"` to `label: "Configure"`

These changes will make the TOC more scannable and cleaner while maintaining the context that users are working within the CodeRabbit documentation site.

### docs/getting-started/quickstart.md(MODIFY)

References: 

- sidebars.ts(MODIFY)

Update the heading on line 39 for consistency with the TOC changes:

Change `## Add CodeRabbit to your repository` to `## Add to your repository`

This ensures the heading within the quickstart guide matches the updated TOC label in `sidebars.ts` and maintains consistency throughout the documentation. The context is clear since users are already within the CodeRabbit documentation.

---

Developer Humor

🧹 Cleaning up the docs, one \CodeRabbit\ at a time,
> Making TOCs scan faster, like a well-tuned rhyme!
> \Get started\ sounds crisp, \Add to your repo\ too,
> Less clutter, more clarity - that's what we'll do! ✨
> 📚 Simplicity wins when navigation's the game! 🎯

---

Execution Information

Branch: main
Commit: eae7edb

---

💡 Tips

Supported Commands (Inside Comments)

• Use @traycerai generate to iterate on the previous version of the implementation plan.

Supported Commands (Inside Description)

• Add @traycerai ignore anywhere in the ticket description to prevent this ticket from being processed.
• Add @traycerai branch:<branch-name> anywhere in the ticket description to specify the target branch for the implementation plan.

Community

• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.