docs: address review comments for DOCS_STYLE_GUIDE.md #21178
Merged
Conversation
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
Address David's feedback from PR #21153: - Update research section to focus on recent documentation - Clarify Premium Feature Callout mentions manifest.json badge - Add Screenshot Guidelines about when screenshots don't exist yet - Update Tabs documentation to explain when to use them - Add mention of referencing Coder registry for cross-links 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
- Add blank line before list after 'When documenting with screenshots' - Fix nested code block examples using quadruple backticks - Resolves markdownlint MD032, MD031, and MD040 errors
david-fraley
approved these changes
Dec 9, 2025
Collaborator
david-fraley
left a comment
There was a problem hiding this comment.
Seems fine. FYI I'm not seeing a comment around the redirects file, but that doesn't need to block merging
I think a comment around the redirects file not working would be good -- #21144
Member
|
Premium in header is ony useful for H2 and below headings fro H1 it automatically comes up if it is present in See this page for example: https://coder.com/docs/ai-coder/ai-bridge |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Summary
This PR addresses David's review comments from PR #21153 to improve the Documentation Style Guide.
Changes
docs/manifest.jsonAll changes maintain the existing documentation structure while improving clarity and specificity based on review feedback.
Refs #21153
🤖 Generated with Claude Code
Co-Authored-By: Claude Sonnet 4.5 noreply@anthropic.com