-
Notifications
You must be signed in to change notification settings - Fork 3k
improve docs style guide #6153
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
Merged
Merged
improve docs style guide #6153
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,16 +1,111 @@ | ||
--- | ||
globs: docs/**/*.{md,mdx} | ||
description: Standards for writing and maintaining Continue Docs | ||
globs: docs/\*_/_.{md,mdx} | ||
description: This style guide should be used as a reference for maintaining consistency across all Continue documentation | ||
alwaysApply: false | ||
--- | ||
|
||
# Continue Docs Standards | ||
# Continue Documentation Style Guide | ||
|
||
## Overview | ||
|
||
## Writing Tone & Voice | ||
|
||
### Conversational and Direct | ||
|
||
- Follow Docusaurus documentation standards | ||
- Include YAML frontmatter with title, description, and keywords | ||
- Use consistent heading hierarchy starting with h2 (##) | ||
- Include relevant Admonition components for tips, warnings, and info | ||
- Use descriptive alt text for images | ||
- Include cross-references to related documentation | ||
- Reference other docs with relative paths | ||
- Use simple, conversational language that gets straight to the point | ||
- Avoid overly technical jargon when simpler terms work | ||
- Write as if speaking directly to the developer using the tool | ||
- Keep paragraphs concise and scannable | ||
- Use code blocks with appropriate language tags | ||
|
||
**Example:** | ||
✅ "You send it a question, and it replies with an answer" | ||
❌ "The system processes user queries and generates corresponding responses" | ||
|
||
### Helpful and Instructional | ||
|
||
- Focus on helping users accomplish their goals | ||
- Use active voice and imperative mood for instructions | ||
- Assume users want to get things done quickly | ||
- Include relevant Admonition components for tips, warnings, and info | ||
|
||
**Example:** | ||
✅ "Press cmd/ctrl + L to begin a new session" | ||
❌ "A new session can be initiated by pressing cmd/ctrl + L" | ||
|
||
### Practical and Task-Oriented | ||
|
||
- Emphasize what users can accomplish with each feature | ||
- Lead with benefits and use cases before diving into mechanics | ||
- Keep explanations grounded in real-world scenarios | ||
|
||
## Content Structure | ||
|
||
### Page Organization | ||
|
||
1. **Visual Introduction**: Lead with GIFs or images showing the feature in action | ||
2. **Purpose Statement**: Brief explanation of what the feature does and when to use it | ||
3. **Step-by-Step Instructions**: Clear, actionable steps with keyboard shortcuts | ||
4. **Platform-Specific Notes**: Separate sections for VS Code and JetBrains when needed | ||
5. **Additional Tips**: Advanced usage or troubleshooting notes | ||
|
||
### Section Headers | ||
|
||
- Use consistent heading hierarchy starting with h2 (##) | ||
- Include YAML frontmatter with title, description, and keywords | ||
- Use action-oriented headers that describe what users will do | ||
- Format: "Verb + object" (e.g., "Type a request and press enter") | ||
- Keep headers concise but descriptive | ||
- Use title case | ||
|
||
**Examples:** | ||
✅ "Highlight code and activate" | ||
✅ "Accept or reject changes" | ||
✅ "Switch between different models" | ||
|
||
### Lists and Steps | ||
|
||
- Use numbered lists for sequential steps | ||
- Use bullet points for feature lists or options | ||
- Keep list items parallel in structure | ||
- Start action items with verbs | ||
|
||
## Technical Writing Standards | ||
|
||
### Code and Keyboard Shortcuts | ||
|
||
- Use `backticks` for inline code elements | ||
- Format keyboard shortcuts consistently: `cmd/ctrl + L` | ||
- Always provide shortcuts for Mac/Windows/Linux | ||
- Use code blocks for configuration examples with proper syntax highlighting | ||
|
||
### Cross-References | ||
|
||
- Link to related sections using descriptive anchor text | ||
- Use relative links to other documentation pages | ||
- Format: `[descriptive text](/path/to/page)` | ||
|
||
### Platform Differences | ||
|
||
- Always address both VS Code and JetBrains when applicable | ||
- Use clear subheadings to separate platform-specific instructions | ||
- Lead with the more common platform (typically VS Code) when both are covered | ||
|
||
## Language Conventions | ||
|
||
### Terminology | ||
|
||
- **Consistent Terms**: Use the same terms throughout (e.g., "LLM" not "AI model" in some places) | ||
- **Product Names**: Capitalize product names correctly (VS Code, JetBrains, Continue) | ||
- **Feature Names**: Use consistent capitalization for Continue features (Chat, Edit, Agent, Autocomplete) | ||
|
||
### Abbreviations | ||
|
||
- Spell out acronyms on first use, then use abbreviation consistently | ||
- Common abbreviations: LLM, IDE, API, URL | ||
|
||
### Pronouns | ||
|
||
- Use "you" to address the user directly | ||
- Use "it" to refer to the tool/model | ||
- Avoid "we" unless referring to the Continue team |
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Might be useful to mention here that we are using Docusaurus