docs: add documentation style guide for AI agents #21152
Closed
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
Adds comprehensive documentation for the Template Insights feature, which was previously undocumented. The documentation covers: - What Template Insights are and their purpose - How to access and use Template Insights - Available metrics (active users, app usage, user activity, latency, parameters) - Use cases for capacity planning, optimization, and support - Permissions and RBAC considerations - Troubleshooting guidance Also updates: - CLAUDE.md with workflow for reading GitHub issues before starting work - dogfood/coder/main.tf with GitHub CLI authentication in startup script - docs/admin/templates/index.md to link to the new documentation 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Adds a screenshot showing the Template Insights page with the Weekly Active Users chart and Latency by user section to help users visualize the feature. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Adds complete documentation for the Template Insights feature covering: - Overview of active users, app usage, user activity, latency, and parameters - Step-by-step access instructions with permission requirements - Visual examples with three screenshots showing key metrics - Use cases for template optimization, capacity planning, and user support - Permission model and data privacy considerations - API access documentation Includes three new screenshots illustrating the insights interface and metrics. Closes #21138 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
This section was added in a previous commit but is unrelated to the Template Insights documentation work.
Proactively documents the --disable-template-insights flag from PR #20940 before it merges, ensuring documentation is ready when the feature lands.
Removed as it's being handled in another PR.
Add comprehensive documentation style guide in .claude/docs/ directory following the format established in PR #21148 for PR_STYLE_GUIDE.md. This guide captures observed patterns from existing Coder documentation including: - Research requirements before writing (code verification, permissions, thresholds) - Document structure and organization patterns - Image usage and screenshot guidelines - Writing style and terminology conventions - Code examples and formatting standards - Documentation manifest requirements - Accuracy standards for specific numbers, permissions, and API endpoints - Proactive documentation approach for upcoming features 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
db3fed0 to
4f46546
Compare
|
|
||
| When disabled, insights data will not be collected or stored, and the Insights tab will not be available in the UI. | ||
|
|
||
| See the [server CLI reference](../../reference/cli/server.md#--disable-template-insights) for more details. |
There was a problem hiding this comment.
🚫 [linkspector] reported by reviewdog 🐶
Cannot reach ../../reference/cli/server.md#--disable-template-insights Status: 404 Cannot find section: #--disable-template-insights in file: /home/runner/work/coder/coder/docs/reference/cli/server.md.
Member
Author
|
Closing in favor of clean PR based off main |
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.
Adds a comprehensive documentation style guide in
.claude/docs/DOCS_STYLE_GUIDE.mddocumenting patterns observed across Coder's existing documentation. This guide is intended for AI agents to reference when writing documentation, ensuring consistency with project conventions.The guide covers research requirements (code verification, permissions model, UI thresholds), document structure (titles, premium callouts, overview sections), image usage (placement, captions, screenshot-driven organization), content organization, writing style, code examples, accuracy standards (specific numbers, permission actions, API endpoints), manifest requirements, and proactive documentation approaches.
Placed in
.claude/docs/alongside other agent-specific documentation (WORKFLOWS.md, ARCHITECTURE.md, etc.) and imported in CLAUDE.md to ensure it's automatically loaded into context for documentation work.🤖 Generated with Claude Code
Co-Authored-By: Claude Sonnet 4.5 noreply@anthropic.com