Skip to content

docs: Restructure docs to a 6-Section Navigation with Guides #6335

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 15 commits into
base: main
Choose a base branch
from

Conversation

bdougie
Copy link
Collaborator

@bdougie bdougie commented Jun 28, 2025

Description

[ What changed? Feel free to be brief. ]

fixes #6265

Restructured Continue's documentation from 10+ sections (with deep and confusing nesting) to 6 main sections for improved discoverability

Key Changes

  • New 6-section structure: Getting Started, Features, Customization, Hub, Advanced, Guides
  • Fixed 50+ broken links and image references after restructuring
  • Added comprehensive redirects for SEO preservation (netlify.toml)
  • Standardized title casing titles ("Quick start" → "Quick Start")

Docs Structure Changes Only

No content was modified - only file locations, navigation structure, and internal linking. All copy remains unchanged.

How to Review

Navigate through the new 6-section structure and assess:

  • Discoverability: Can you find features without prior knowledge?
  • Logical grouping: Do sections make intuitive sense?
  • Navigation flow: Is the user journey smooth?
  • Please avoid reviewing the content, as it is unchanged, just moved to different pages.
  • All links have been verified to be 301 or 200 via CI

Checklist

  • I've read the contributing guide
  • The relevant docs, if any, have been updated or created
  • The relevant tests, if any, have been updated or created

Screenshots

[ For visual changes, include screenshots. Screen recordings are particularly helpful, and appreciated! ]

Screenshot 2025-06-27 at 11 15 51 PM Screenshot 2025-06-27 at 11 15 27 PM

Tests

[ What tests were added or updated to ensure the changes work as expected? ]


Summary by cubic

Restructured the documentation into 6 main sections for easier navigation and better discoverability, replacing deep nesting and fixing over 50 broken links and images.

  • Migration
    • Added redirects to preserve old URLs and SEO.
    • Standardized title casing across docs.
    • No content changes; only file locations, navigation, and internal links were updated.

@bdougie bdougie requested a review from a team as a code owner June 28, 2025 06:17
@bdougie bdougie requested review from RomneyDa and removed request for a team June 28, 2025 06:17
@dosubot dosubot bot added the size:XL This PR changes 500-999 lines, ignoring generated files. label Jun 28, 2025
Copy link

netlify bot commented Jun 28, 2025

Deploy Preview for continuedev ready!

Name Link
🔨 Latest commit 28bc74b
🔍 Latest deploy log https://app.netlify.com/projects/continuedev/deploys/685ff9c5d5623a0008b2cde2
😎 Deploy Preview https://deploy-preview-6335--continuedev.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

Comment on lines +62 to +64
gtag: {
trackingID: "G-M3JWW8N2XQ",
anonymizeIP: true,
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this got added due to an error I was seeing in dev. Let me my find out if the anonymizeIP is needed.

docs/CLA.md Outdated
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Moved to the root since I did not see it rendered in the production. Not sure if it is in meant to be on the page or just a reference for contributors.

@bdougie bdougie changed the title docs: Documentation Restructure to a 6-Section Navigation with Guides docs: Restructure docs to a 6-Section Navigation with Guides Jun 28, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
size:XL This PR changes 500-999 lines, ignoring generated files.
Projects
Status: Todo
Development

Successfully merging this pull request may close these issues.

Docs: Add Features Section to docs
1 participant