continue icon indicating copy to clipboard operation
continue copied to clipboard

[CON] - Docs Layout Refactor

Open priyashpatil opened this issue 1 year ago • 1 comments

As per the discussion with the team the following is the summary for new docs structure:

The docs will be organized into top-level sections by navbar links, defined like here, or in their documentation here. Each of these navbar headers will link to a separate “sidebar”.

Under each sidebar, I’m denoting each page by a bullet point, and nested bullet points indicate a collapsible category like here.

“Docs” Sidebar

  • [ ] Install
    • [ ] Introduction
    • [ ] VS Code
    • [ ] JetBrains
    • [ ] How to use Continue
    • [ ] Troubleshooting
  • [ ] Tutorials
    • [ ] Example configuration files
    • [ ] How to select an LLM (this would be a combination of Select Providers and Select Models)
    • [ ] How to setup Codestral
    • [ ] Using Llama 3.1 with Continue
    • [ ] How to use config.json (a page to describe the basics of config.json: short list of features, where it is stored, how to edit it, how it is reloaded automatically, etc.)
  • [ ] Features
    • [ ] Chat Sidebar
    • [ ] Codebase retrieval
    • [ ] Tab autocomplete
    • [ ] Inline edits
    • [ ] Context Providers
    • [ ] Slash Commands
    • [ ] Prompt files
    • [ ] Quick actions
    • [ ] [we will probably add more later]
  • [x] Privacy - #1910
    • [x] Development Data - #1910
    • [x] Telemetry - #1910
    • [x] Privacy Policy - #1910
  • [ ] Advanced
    • [ ] Authentication
    • [ ] Customizing prompts (this page should explain that Continue automatically detects prompts from the model name, but if you need to customize: Continue uses Handlebars syntax to define prompt formats, and you can customize 1. Chat template, 2. /edit template, and 3. Autocomplete template) (then there are sections for “Customizing the chat template”, “Customizing the /edit prompt”, and “Customizing the autocomplete prompt”)
    • [ ] Defining a Custom LLM Provider
    • [ ] Building a custom context provider
    • [ ] Building a custom slash command

“Reference” Sidebar

“Community” Sidebar

  • [ ] Code of Conduct
  • [ ] Roadmap
  • [ ] FAQ
  • [ ] Contributing
  • [ ] Changelog
    • [ ] VS Code
    • [ ] JetBrains
  • [ ] Support

Related Issues: #1741 #1745 #1803 #1707 #1344

priyashpatil avatar Aug 01 '24 08:08 priyashpatil