Clean up "Quick start" terminology and update sidebar navigation - #147
Merged
anupama-pathirage merged 9 commits intoApr 28, 2026
Merged
Conversation
…tion and update sidebars
Sachindu-Nethmin
requested review from
KavinduZoysa,
NipunaRanasinghe,
anupama-pathirage and
rosensilva
as code owners
April 21, 2026 09:40
Contributor
|
Note Reviews pausedIt looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the Use the following commands to manage reviews:
Use the checkboxes below for quick actions:
Note
|
| Cohort / File(s) | Summary |
|---|---|
Build Documentation Pages en/docs/get-started/build-ai-agent.md, en/docs/get-started/build-automation.md, en/docs/get-started/build-api-integration.md, en/docs/get-started/build-event-driven-integration.md, en/docs/get-started/build-file-driven-integration.md |
Updated page titles from "Quick Start" phrasing to "Build" phrasing. Updated "What's next" navigation sections to link to corresponding build-oriented pages instead of quick-start pages. |
Reference Documentation en/docs/reference/faq.md, en/docs/reference/release-notes.md |
Updated "What's next" links from "Quick Start Guide" to "Build an API Integration", redirecting from /docs/get-started/quick-start-api to /docs/get-started/build-api-integration. |
Navigation & Configuration en/sidebars.ts, en/docusaurus.config.ts, en/src/pages/index.tsx |
Updated sidebar doc IDs and homepage links from quick-start-* to build-* paths. Updated hero CTA button and popular pages quick-links to point to new build documentation routes. |
Setup Documentation en/docs/get-started/install.md |
Updated "Next steps" link from "Quick start: Integration as API" to "Build an API integration", targeting the new build-api-integration page. |
Content Generation Mapping en/content-gen/01-get-started.md |
Updated file path mappings for five get-started pages from quick-start-*.md to corresponding build-*.md filenames in the content generation configuration. |
Estimated code review effort
🎯 2 (Simple) | ⏱️ ~12 minutes
Poem
🐰 Hopping through docs with a brand-new spring,
We're building, not starting—hear the changes ring!
From "Quick Start" to "Build," the pages now gleam,
Navigation refreshed, a more purposeful dream.
Quick links rerouted with care and with cheer,
Our documentation's evolution is here! 🌱
🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
| Check name | Status | Explanation |
|---|---|---|
| Title check | ✅ Passed | The title clearly and concisely summarizes the main changes: removing redundant 'Quick start' terminology and updating sidebar navigation structures across documentation files. |
| Description check | ✅ Passed | The PR description comprehensively covers all major template sections including Purpose, Goals, Approach, User stories, Release notes, and test environment details. The author properly explains the documentation restructuring with clear context and methodology. |
| Docstring Coverage | ✅ Passed | Docstring coverage is 100.00% which is sufficient. The required threshold is 80.00%. |
| Linked Issues check | ✅ Passed | Check skipped because no linked issues were found for this pull request. |
| Out of Scope Changes check | ✅ Passed | Check skipped because no linked issues were found for this pull request. |
✏️ Tip: You can configure your own custom pre-merge checks in the settings.
✨ Finishing Touches
🧪 Generate unit tests (beta)
- Create PR with unit tests
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.
Comment @coderabbitai help to get the list of available commands and usage tips.
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Actionable comments posted: 3
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@en/docs/reference/faq.md`:
- Line 172: Replace the left-side link text "[Quick Start Guide]" in the
markdown link that points to /docs/get-started/build-api-integration with a
matching title such as "[Build your first integration]" so the visible label
aligns with the renamed page; locate the markdown link instance (the line with
the [Quick Start Guide](...build-api-integration)) and update the bracketed text
accordingly.
In `@en/docs/reference/release-notes.md`:
- Line 118: Update the markdown link label to match the renamed destination:
replace the link text "[Quick Start Guide]" that points to
"/docs/get-started/build-api-integration" with a matching label such as "[Build
API Integration]" (or other exact destination title) so the visible label and
the target URL are consistent in release-notes.md.
In `@en/src/pages/index.tsx`:
- Around line 282-284: Update the visible suggestion labels in the Popular pages
array in en/src/pages/index.tsx so they exactly match the renamed page titles
used in those pages' metadata/sidebar: change the object with to:
'/docs/get-started/build-automation', the one with to:
'/docs/get-started/build-ai-agent', and the one with to:
'/docs/get-started/build-api-integration' so each label string equals the
canonical page title (from the page frontmatter/sidebar) rather than the current
mixed wording; locate and edit the array entries with the properties label and
to to set the labels to the exact titles.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 6aba65ee-368c-463b-8fca-748f410d0ac0
📒 Files selected for processing (17)
en/docs/genai/mcp/overview.mden/docs/genai/quick-starts/build-conversational-agent.mden/docs/genai/quick-starts/build-rag-application.mden/docs/genai/quick-starts/expose-mcp-server.mden/docs/get-started/build-ai-agent.mden/docs/get-started/build-api-integration.mden/docs/get-started/build-automation.mden/docs/get-started/build-event-driven-integration.mden/docs/get-started/build-file-driven-integration.mden/docs/get-started/first-project.mden/docs/get-started/install.mden/docs/get-started/understand-the-ide.mden/docs/reference/faq.mden/docs/reference/release-notes.mden/docusaurus.config.tsen/sidebars.tsen/src/pages/index.tsx
Contributor
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@en/sidebars.ts`:
- Around line 47-51: The new sidebar doc IDs (get-started/build-automation,
get-started/build-ai-agent, get-started/build-api-integration,
get-started/build-event-driven-integration,
get-started/build-file-driven-integration) map to build-automation.md,
build-ai-agent.md, build-api-integration.md, build-event-driven-integration.md,
and build-file-driven-integration.md; open each of those files and update any
image src paths that reference /img/get-started/quick-start-*/ to the new image
directory names (or correct relative paths) used after migration so they point
to existing assets, and also update the five corresponding references in
en/content-gen/01-get-started.md (around the previously noted lines) to the same
new image paths for consistency.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: ebc3d437-8fd2-4530-abab-828c60a6cc5a
📒 Files selected for processing (5)
en/docs/reference/faq.mden/docs/reference/release-notes.mden/docusaurus.config.tsen/sidebars.tsen/src/pages/index.tsx
✅ Files skipped from review due to trivial changes (2)
- en/docusaurus.config.ts
- en/docs/reference/faq.md
🚧 Files skipped from review as they are similar to previous changes (2)
- en/src/pages/index.tsx
- en/docs/reference/release-notes.md
…emove-quick-start
…min/docs-integrator into remove-quick-start
anupama-pathirage
previously approved these changes
Apr 28, 2026
…emove-quick-start
… directories and update references.
anupama-pathirage
approved these changes
Apr 28, 2026
Open
5 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Purpose
The navigation bar and page titles in the "Get Started" section contained redundant "Quick start — " prefixes. Since these pages are already grouped under a "Quick starts" category in the sidebar, the extra naming was repetitive and made the UI cluttered.
Goals
Approach
quick-start-*.mdfiles to more concisebuild-*.mdvariants to align with a skill-building approach.titlein each file's frontmatter and removed "Quick Start: " from headings.sidebars.tsto use the new clean IDs while maintaining the "Quick starts" category grouping.get-startedandreferencesections to update internal relative links and ensure navigation integrity.User stories
As a new developer, I want a clean and concise navigation menu so that I can easily find the specific integration guides I need without repetitive labeling.
Release note
Standardized the naming of "Get Started" guide pages and improved navigation consistency by removing redundant prefixes in the sidebar and page titles.
Documentation
N/A (This PR is purely a documentation restructuring).
Training
N/A
Certification
N/A
Marketing
N/A
Automation tests
N/A
N/A
Security checks
Samples
N/A
Related PRs
N/A
Migrations (if applicable)
N/A
Test environment
Learning
Followed the Documentation Blueprint (March 2026) for section organization and "Get Started" content principles.
Summary by CodeRabbit