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

bdougie · 2025-06-28T06:17:53Z

Description

[ What changed? Feel free to be brief. ]

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

https://screen.studio/share/cYqpX02F

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! ]

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.

netlify · 2025-06-28T06:17:58Z

✅ Deploy Preview for continuedev ready!

Name	Link
🔨 Latest commit	`742c3df`
🔍 Latest deploy log	https://app.netlify.com/projects/continuedev/deploys/68658678d1ccf80008b583a8
😎 Deploy Preview	https://deploy-preview-6335--continuedev.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

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

bdougie · 2025-06-28T14:16:03Z

docs/docusaurus.config.js

+          gtag: {
+            trackingID: "G-M3JWW8N2XQ",
+            anonymizeIP: true,


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

bdougie · 2025-06-28T14:17:22Z

docs/CLA.md

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.

RomneyDa · 2025-06-30T19:08:06Z

docs/netlify.toml

I think all redirects should use redirects in the docusaurus config, any reason for extra ones here?

RomneyDa · 2025-06-30T19:10:58Z

docs/docs/advanced/context-integration/custom-providers.mdx

I think we shouldn't put context providers under "Custom providers", since we have a separate idea of a "custom context provder" in the code for config.ts. These are more like "Built In" context providers

I am not sure I am following the suggestion, but the thought here is Context Provider are an advanced feature (for now) and we need to focus a story on core features while focus navigate the docs.

If you provide more specifics, I'd be happy to move them to wherever for now, but for context. Our docs are simply not being leveraged by users and Context providers is the 17/20th most visited page at 3k uniques in the last 10days. That is not popular by a far margin.

FWIW - Context in general has a bit of docs tech debt.

i.e. #6360 & #6081

RomneyDa · 2025-06-30T19:14:14Z

docs/docs/guides/best-practices.mdx

Flagging lorem ipsum stuff

RomneyDa · 2025-06-30T19:14:29Z

docs/docs/guides/ollama-guide.mdx

Flagging lorem ipsum

RomneyDa · 2025-06-30T19:14:48Z

docs/docs/hub/governance/creating-an-org.md

@@ -1,6 +1,6 @@
 ---
-title: Creating an Organization
-description: Creating an Organization
+title: Creating An Organization


lower case is correct here for "an" in title

over zealous model here. I will need to fix a few of these.

RomneyDa · 2025-06-30T19:15:36Z

docs/docs/advanced/deep-dives/_category_.json

I think you can do this in the header of the md file

I tried this, and there are extra things the _category.json gives. It give every section a generated index overviews. These are needed to not have an undefined LLMs.txt

{ "label": "Guides", "position": 6, "link": { "type": "generated-index", "title": "Guides", "description": "Learn how to use Continue with comprehensive guides and tutorials" } }

It also Title cases all the files without frontmatter.

With _category.json:

Without

Just confirmed the _category.json is need for a more expansive llms.txt. https://github.com/din0s/docusaurus-plugin-llms-txt?tab=readme-ov-file#documentation-structure

https://deploy-preview-6335--continuedev.netlify.app/llms.txt

RomneyDa · 2025-06-30T19:15:54Z

docs/docs/advanced/00-overview.mdx

This is awesome

Patrick-Erichsen · 2025-06-30T22:49:40Z

docs/docs/features/00-overview.mdx

+# Core Features
+
+Continue provides four powerful AI-assisted development features that work seamlessly within your IDE.


This feels quite similar to /getting-started/overview. Wondering if we should combine. If we did that, we could also then move /getting-started/install out of a dropdown and into a top-level section in the sidebar which might be nice.

This gets into the weeds in updating the actual content. I am going to track this in the "Quick Start" issue instead.

Patrick-Erichsen · 2025-06-30T22:54:55Z

docs/docs/features/chat/how-it-works.mdx

+
+## Session Management
+
+- Use `Cmd/Ctrl + L` (VS Code) or `Cmd/Ctrl + J` (JetBrains) to start a new session


We use <kbd /> elements on other pages, e.g. <kbd>cmd</kbd> + <kbd>shift</kbd> + <kbd>P</kbd> on https://docs.continue.dev/troubleshooting#vs-code

It renders a fancier looking keyboard key. I don't necessarily love them, but if we decide not to use them we should probably replace all instances of <kbd /> with regualr codeblock formatting like we use here.

I have a linear issue to follow up on this. This was copied from an existing doc, and it will be easier to audit all of these instances in a single PR, but can update this instance since its a net new.

https://linear.app/continue/issue/CON-2176/keyboard-commands-in-docs-need-consistency-macos-windows

That's right. It is not the same command/ctrl change to windows for VS Code specifically, which is why I started the linear issue. There is some nuance, which I will need to rethink how this command is shared, probably a TAB, but out of scope for this PR. I will track via Linear.

Patrick-Erichsen · 2025-06-30T22:57:14Z

docs/docs/advanced/troubleshooting.mdx

I lean towards keeping this as a top level sidebar item, but that might be a maintainer specific viewpoint so don't feel strongly

Valid take. From the data (Posthog), it is not a top 20 clicked page. My guess is either folks don't make it to TroubleShooting, or search is enough. The hope is the LLMs.txt will be the solution eventually thanks to GEO.

Here's the list of the top 20 most visited docs pages on your site:

Homepage - 28,642 visits
Getting Started: Install - 10,069 visits
Customize: Deep Dives Autocomplete - 9,006 visits
Autocomplete: Model Setup - 8,745 visits
Chat: Model Setup - 8,139 visits
Getting Started: Overview - 8,095 visits
Agent: How to Use It - 7,206 visits
Reference - 7,146 visits
Chat: How to Use It - 5,398 visits
Customize: Model Providers - 5,061 visits
Agent: Model Setup - 4,256 visits
Autocomplete: How to Use It - 4,171 visits
Customize: Deep Dives MCP - 3,961 visits
Customize: Model Roles Reranking - 3,405 visits
Customize: Model Roles Chat - 3,289 visits
Customize: Overview - 3,211 visits
Customize: Context Providers - 3,129 visits
Customize: Model Providers Ollama - 2,972 visits
Chat: Context Selection - 2,924 visits
Customize: Deep Dives Codebase - 2,813 visits

Patrick-Erichsen · 2025-06-30T23:01:04Z

docs/docusaurus.config.js

I had to add the following to run this locally:

future: { experimental_faster: true, + v4: true, },

Probably just a local thing for me but curious if you had any issues with the experimental_faster.

Patrick-Erichsen

Huge improvement! Really nice to be back down to a single sidebar.

Only high level comment I have is that I'm wondering if we should just fully remove the Chinese docs at this point. It doesn't seem feasible to keep them up to date with our work.

Also merged main to resolve a conflict from a PR I recently merged

bdougie

I will address more of your comments and reviews later tonight @RomneyDa and @Patrick-Erichsen - thanks for taking a look

bdougie · 2025-06-30T23:33:20Z

docs/netlify.toml

bdougie · 2025-06-30T23:34:11Z

docs/docs/hub/governance/creating-an-org.md

@@ -1,6 +1,6 @@
 ---
-title: Creating an Organization
-description: Creating an Organization
+title: Creating An Organization


over zealous model here. I will need to fix a few of these.

bdougie · 2025-06-30T23:36:56Z

docs/docs/features/chat/how-it-works.mdx

+
+## Session Management
+
+- Use `Cmd/Ctrl + L` (VS Code) or `Cmd/Ctrl + J` (JetBrains) to start a new session


That's right. It is not the same command/ctrl change to windows for VS Code specifically, which is why I started the linear issue. There is some nuance, which I will need to rethink how this command is shared, probably a TAB, but out of scope for this PR. I will track via Linear.

bdougie · 2025-06-30T23:41:41Z

docs/docs/advanced/troubleshooting.mdx

Valid take. From the data (Posthog), it is not a top 20 clicked page. My guess is either folks don't make it to TroubleShooting, or search is enough. The hope is the LLMs.txt will be the solution eventually thanks to GEO.

Here's the list of the top 20 most visited docs pages on your site:

Homepage - 28,642 visits
Getting Started: Install - 10,069 visits
Customize: Deep Dives Autocomplete - 9,006 visits
Autocomplete: Model Setup - 8,745 visits
Chat: Model Setup - 8,139 visits
Getting Started: Overview - 8,095 visits
Agent: How to Use It - 7,206 visits
Reference - 7,146 visits
Chat: How to Use It - 5,398 visits
Customize: Model Providers - 5,061 visits
Agent: Model Setup - 4,256 visits
Autocomplete: How to Use It - 4,171 visits
Customize: Deep Dives MCP - 3,961 visits
Customize: Model Roles Reranking - 3,405 visits
Customize: Model Roles Chat - 3,289 visits
Customize: Overview - 3,211 visits
Customize: Context Providers - 3,129 visits
Customize: Model Providers Ollama - 2,972 visits
Chat: Context Selection - 2,924 visits
Customize: Deep Dives Codebase - 2,813 visits

…nue into bdougie/docs-structure

bdougie · 2025-07-02T17:39:05Z

updated the side nav to have Troubleshooting and Reference making it 8 items. Based on this interaction in Discord. https://discord.com/channels/1108621136150929458/1389889311457022004/1390021752117006336

bdougie added 11 commits June 27, 2025 16:43

The Plan

40947df

audit links that need to change

774a62e

create new structure and redirects

8646215

docs migration

0a1cd05

working build

3905bbf

more structural fixes

3b6d7c4

tested redirects and broken links

72208f2

fix 404 images

d701c70

move guides 6th section

2fdae32

return CLA

0d8d0cb

remove planning docs

a1ea47d

bdougie requested a review from a team as a code owner June 28, 2025 06:17

bdougie requested review from RomneyDa and removed request for a team June 28, 2025 06:17

github-project-automation bot added this to Issues and PRs Jun 28, 2025

github-project-automation bot moved this to Todo in Issues and PRs Jun 28, 2025

dosubot bot added the size:XL This PR changes 500-999 lines, ignoring generated files. label Jun 28, 2025

bdougie added 3 commits June 27, 2025 23:25

fix build

415e2a0

prettier

9eeeca5

fix build

8479991

bdougie commented Jun 28, 2025

View reviewed changes

fix all broken links

28bc74b

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

bdougie requested review from a team June 30, 2025 17:34

RomneyDa requested changes Jun 30, 2025

View reviewed changes

github-project-automation bot moved this from Todo to In Progress in Issues and PRs Jun 30, 2025

removes lorem ipsum

aa2a98c

move redirects to docusaurus

f306b50

Patrick-Erichsen reviewed Jun 30, 2025

View reviewed changes

Merge branch 'main' into bdougie/docs-structure

fa6ec23

bdougie commented Jun 30, 2025

View reviewed changes

bdougie added 4 commits July 1, 2025 16:41

title case fix

6bbec66

Merge branch 'bdougie/docs-structure' of github.com:continuedev/conti…

e1bd90f

…nue into bdougie/docs-structure

Merge branch 'main' into bdougie/docs-structure

c067432

fix build

bc857bc

bdougie requested a review from RomneyDa July 2, 2025 01:26

move reference and troubleshooting to sidebar

bd8d435

bdougie changed the title ~~docs: Restructure docs to a 6-Section Navigation with Guides~~ docs: Restructure docs to a 8-Section Navigation with Guides Jul 2, 2025

fix build

083ef5a

bdougie force-pushed the bdougie/docs-structure branch from 2259f64 to 083ef5a Compare July 2, 2025 17:57

fix broken referencelinks

742c3df

		# Core Features

		Continue provides four powerful AI-assisted development features that work seamlessly within your IDE.


		## Session Management

		- Use `Cmd/Ctrl + L` (VS Code) or `Cmd/Ctrl + J` (JetBrains) to start a new session

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

Are you sure you want to change the base?

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

Conversation

bdougie commented Jun 28, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Key Changes

Docs Structure Changes Only

How to Review

Checklist

Screenshots

Tests

Summary by cubic

Uh oh!

netlify bot commented Jun 28, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for continuedev ready!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

bdougie Jul 2, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Patrick-Erichsen left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

bdougie left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

bdougie commented Jun 28, 2025 •

edited

Loading

netlify bot commented Jun 28, 2025 •

edited

Loading

bdougie Jul 2, 2025 •

edited

Loading

Patrick-Erichsen left a comment •

edited

Loading