Skip to content

docs: Adds separate indexable FAQs in docs #7139

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.

Sign up for GitHub

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

Jump to bottom
Merged
RomneyDa merged 7 commits into from
Aug 19, 2025
Merged

docs: Adds separate indexable FAQs in docs #7139

RomneyDa merged 7 commits into from
Aug 19, 2025

Conversation

@bdougie
Copy link
Collaborator

@bdougie bdougie commented Aug 14, 2025 •
edited
Loading

Description

[ What changed? Feel free to be brief. ]

While exploring an answer I could not easily find it in troubleshooting. I also know /faqs are performing well in LLM search, so I made a change to move FAQs to its own sections for discoverability and better linking.

https://continue-docs-bdougie-faqs.mintlify.app/faqs

AI Code Review

  • Team members only: AI review runs automatically when PR is opened or marked ready for review
  • Team members can also trigger a review by commenting @continue-general-review or @continue-detailed-review

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

Screen recording or screenshot

[ When applicable, please include a short screen recording or screenshot - this makes it much easier for us as contributors to review and understand your changes. See this PR as a good example. ]

Screenshot 2025-08-14 at 4 31 05 AM

Tests

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

https://continue-docs-bdougie-faqs.mintlify.app/faqs

Summary by cubic

Moved FAQs to a separate, indexable section in the docs to make answers easier to find and link to.

  • Docs Update
  • Added a dedicated /faqs page and redirected relevant troubleshooting links.
  • Improved FAQ discoverability for users and search engines.

@bdougie bdougie marked this pull request as ready for review August 14, 2025 03:37
@bdougie bdougie requested a review from a team as a code owner August 14, 2025 03:37
@bdougie bdougie requested review from RomneyDa and removed request for a team August 14, 2025 03:37
@dosubot dosubot bot added the size:L This PR changes 100-499 lines, ignoring generated files. label Aug 14, 2025
@github-actions
Copy link

github-actions bot commented Aug 14, 2025

AI Code Review

undefined

No specific line comments generated.

@github-actions
Copy link

github-actions bot commented Aug 14, 2025

Code Review Summary

✅ Strengths

  • Documentation Organization: The PR effectively separates FAQs from the troubleshooting page, creating a dedicated space for frequently asked questions. This improves documentation structure and makes it easier for users to find specific information.
  • Redirect Management: Comprehensive redirects are properly configured in docs.json to ensure all existing links to troubleshooting FAQ sections will seamlessly redirect to the new FAQs page, preventing broken links.
  • Content Preservation: All FAQ content from the troubleshooting page has been successfully migrated to the new FAQs page without any loss of information.
  • Navigation Update: The navigation structure in docs.json is correctly updated to include the new FAQs page alongside the troubleshooting page in the "Help" section.

⚠️ Issues Found

Low

  • Typo in Directory Path: In the FAQs page under "How do I reset the state of the extension?", there's a typo in the Windows path. It says %USERPROFILE%.continue\ but should be %USERPROFILE%\.continue
  • JSON Formatting: The JSON code block in the FAQs page has inconsistent formatting with compressed whitespace that makes it less readable

💡 Suggestions

  • Consider Cross-References: Add a note at the top of the troubleshooting page indicating that FAQs have been moved to their own page for better clarity
  • FAQ Organization: Consider organizing FAQs into categories (e.g., "Installation Issues", "Configuration Issues", "IDE-Specific Issues") with subheadings for better navigation
  • Search Optimization: The FAQs page could benefit from a brief introduction explaining its purpose and potentially including keywords to improve searchability

🚀 Overall Assessment

APPROVE

This is a well-executed documentation refactoring that improves the organization and accessibility of troubleshooting information. The separation of FAQs into a dedicated page follows documentation best practices and makes the content more maintainable. The comprehensive redirect setup ensures a smooth transition without breaking existing links. The minor issues identified are cosmetic and don't impact functionality.

github-actions[bot]
github-actions bot reviewed Aug 14, 2025
View reviewed changes
Copy link

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

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

This PR refactors the troubleshooting documentation by moving FAQ content to a dedicated faqs.mdx file and adding comprehensive redirect mappings. The changes improve documentation organization but have several issues with formatting, broken links, and redirect configuration that need to be addressed.

@github-actions
Copy link

github-actions bot commented Aug 14, 2025

Code Review Summary

✅ Strengths

  • Content Organization: Good separation of FAQ content from troubleshooting guide, making documentation more maintainable and discoverable
  • Redirect Implementation: Comprehensive redirects ensure all existing deep links to troubleshooting sections continue to work
  • Navigation Structure: Proper integration into the documentation navigation under the "Help" section

⚠️ Issues Found

Low

  • JSON Formatting: The JSON code block in faqs.mdx has incorrect formatting. The objects in the models array should have proper key names ("name" not "title") and the JSON structure appears to have formatting issues with extra spaces and commas.
  • Windows Path Typo: In the "How do I reset the state of the extension?" section, there's a typo in the Windows path: %USERPROFILE%.continue\ should be %USERPROFILE%\.continue\
  • Missing New Assistant FAQ: A new FAQ about assistants not updating in VS Code was added. While helpful, it might be worth verifying if this issue is specific to VS Code or also affects JetBrains IDEs.

💡 Suggestions

  • Cross-referencing: Consider adding a note in the troubleshooting page that more specific issues can be found in the FAQs page, beyond just the link in step 5
  • Search Optimization: The FAQ page could benefit from a table of contents at the top for easier navigation, especially as it grows
  • Consistency: Ensure the JSON and YAML examples use consistent model configuration keys across all documentation

🚀 Overall Assessment

APPROVE

This is a well-executed documentation refactoring that improves the organization and maintainability of the help content. The separation of FAQs from troubleshooting steps is logical, and the redirect implementation ensures no broken links. The minor issues identified are cosmetic and don't impact the functionality or user experience significantly.

RomneyDa
RomneyDa previously approved these changes Aug 14, 2025
View reviewed changes
@github-project-automation github-project-automation bot moved this from Todo to In Progress in Issues and PRs Aug 14, 2025
@dosubot dosubot bot added the lgtm This PR has been approved by a maintainer label Aug 14, 2025
@bdougie bdougie requested a review from RomneyDa August 14, 2025 22:14
bdougie and others added 2 commits August 14, 2025 23:48
@bdougie
fix: FAQs first
b0e3dca
@bdougie
docs: add comprehensive Ollama troubleshooting guide (#7209)
187b4d4 
* docs: add comprehensive Ollama troubleshooting guide

- Add solutions for local connection issues
- Document remote Ollama configuration steps
- Include WSL-specific networking fixes
- Add Docker container connectivity solutions
- Cover parse error troubleshooting

Addresses common Ollama integration problems users face when setting up Continue with local, remote, WSL, and containerized Ollama instances.

* docs: add local assistant secrets management section to FAQs

- Added comprehensive documentation for managing local secrets and environment variables
- Included multiple methods for configuring .env files (workspace, global, process)
- Added examples showing how to use secrets in config.yaml
- Explained difference between local secrets and Hub-managed secrets
- Added troubleshooting tips for common secret configuration issues
- Added link to Ollama guide for better discoverability
- Added link to offline usage guide for users without internet access

* docs: add model addons usage documentation for local assistants

- Document how to use hub model addons in local assistant configs
- Show examples of using 'uses:' syntax with provider/model-name format
- Explain how to combine hub addons with local model configurations
- Include override example for customizing addon settings locally
- Add requirements section noting login and internet connection needed

* fix: resolve broken image links in documentation

- Fixed broken link to plan mode selector image (use plan-mode-selector.png)
- Fixed broken link to assistant extension selector image
- Removed broken link to non-existent /features/plan/how-to-customize page
@dosubot dosubot bot added size:XL This PR changes 500-999 lines, ignoring generated files. and removed size:L This PR changes 100-499 lines, ignoring generated files. labels Aug 18, 2025
@bdougie bdougie changed the title docs: Adds separate but and indexable FAQs in docs docs: Adds separate indexable FAQs in docs Aug 18, 2025
@RomneyDa RomneyDa merged commit 3700132 into main Aug 19, 2025
67 of 69 checks passed
@RomneyDa RomneyDa deleted the bdougie/faqs branch August 19, 2025 00:20
@github-project-automation github-project-automation bot moved this from In Progress to Done in Issues and PRs Aug 19, 2025
@github-actions github-actions bot locked and limited conversation to collaborators Aug 19, 2025
@sestinj
Copy link
Contributor

sestinj commented Aug 19, 2025

🎉 This PR is included in version 1.6.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

@sestinj
Copy link
Contributor

sestinj commented Aug 22, 2025

🎉 This PR is included in version 1.9.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Reviewers

@github-actions github-actions[bot] github-actions[bot] left review comments

@RomneyDa RomneyDa RomneyDa approved these changes

Assignees

No one assigned

Labels

lgtm This PR has been approved by a maintainer released size:XL This PR changes 500-999 lines, ignoring generated files.

Projects

Issues and PRs
Status: Done

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@bdougie @sestinj @RomneyDa