You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
docs: remove unused _redirects file and document redirect process
The _redirects file format is used by Netlify and Cloudflare Pages, but
coder.com runs on Vercel with Next.js. Redirects for coder.com/docs must
be configured in the coder/coder.com repository redirects.json file.
This file was never functional and caused confusion when renaming docs.
Changes:
- Remove docs/_redirects
- Add URL Redirects section to .claude/docs/DOCS_STYLE_GUIDE.md
- Fix pre-existing markdown lint issues in DOCS_STYLE_GUIDE.md
Copy file name to clipboardExpand all lines: .claude/docs/DOCS_STYLE_GUIDE.md
+21-10Lines changed: 21 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,7 +6,7 @@ This guide documents documentation patterns observed in the Coder repository, ba
6
6
7
7
Before documenting a feature:
8
8
9
-
1.**Research similar documentation** - Read recent documentation pages in `docs/` to understand writing style, structure, and conventions for your content type (admin guides, tutorials, reference docs, etc.)
9
+
1.**Research similar documentation** - Read 10+ similar pages in `docs/` to understand writing style, structure, and conventions for your content type (admin guides, tutorials, reference docs, etc.)
3.**Verify permissions model** - Look up RBAC actions in `coderd/rbac/` (e.g., `view_insights` for Template Insights)
12
12
4.**Check UI thresholds and defaults** - Review frontend code for color thresholds, time intervals, display logic
@@ -42,7 +42,10 @@ Template Insights provides detailed analytics and usage metrics for your Coder t
42
42
43
43
### Premium Feature Callout
44
44
45
-
For Premium-only features, add `(Premium)` suffix to the H1 heading. The documentation system automatically links these to premium pricing information. You should also add a premium badge in the `docs/manifest.json` file with `"state": ["premium"]`.
45
+
For Premium-only features:
46
+
47
+
1. Add `(Premium)` suffix to the H1 heading - the documentation system automatically links these to premium pricing information
48
+
2. Add premium badge in `manifest.json` with `"state": ["premium"]`
46
49
47
50
```markdown
48
51
# Template Insights (Premium)
@@ -91,7 +94,7 @@ When you have multiple screenshots showing different aspects of a feature:
91
94
92
95
### Screenshot Guidelines
93
96
94
-
**When screenshots are not yet available**: If you're documenting a feature before screenshots exist, you can use image placeholders with descriptive alt text and ask the user to provide screenshots:
97
+
**When screenshots are not available**: Use image placeholders with descriptive alt text and ask the user to provide screenshots:
95
98
96
99
```markdown
97
100

@@ -131,7 +134,7 @@ Then ask: "Could you provide a screenshot of the Template Insights page? I've ad
131
134
-`> [!NOTE]` for additional information
132
135
-`> [!WARNING]` for important warnings
133
136
-`> [!TIP]` for helpful tips
134
-
-**Tabs**: Use tabs for presenting related but parallel content, such as different installation methods or platform-specific instructions. Tabs work well when readers need to choose one path that applies to their specific situation.
137
+
-**Tabs**: Use tabs to present related but parallel documentation paths (e.g., different installation methods, platform-specific instructions)
135
138
136
139
## Writing Style
137
140
@@ -160,19 +163,17 @@ Then ask: "Could you provide a screenshot of the Template Insights page? I've ad
160
163
161
164
### Command Examples
162
165
163
-
````markdown
166
+
Use `sh` language for shell commands:
167
+
164
168
```sh
165
169
coder server --disable-template-insights
166
170
```
167
-
````
168
171
169
172
### Environment Variables
170
173
171
-
````markdown
172
174
```sh
173
175
CODER_DISABLE_TEMPLATE_INSIGHTS=true
174
176
```
175
-
````
176
177
177
178
### Code Comments
178
179
@@ -189,8 +190,6 @@ Use relative paths from current file location:
For cross-linking to Coder registry templates or other external Coder resources, reference the appropriate registry URLs.
193
-
194
193
### Cross-References
195
194
196
195
- Link to related documentation at the end
@@ -300,10 +299,22 @@ Some content is auto-generated with comments:
300
299
301
300
Don't manually edit auto-generated sections.
302
301
302
+
## URL Redirects
303
+
304
+
When renaming or moving documentation pages, redirects must be added to prevent broken links.
305
+
306
+
**Important**: Redirects are NOT configured in this repository. The coder.com website runs on Vercel with Next.js and reads redirects from a separate repository:
0 commit comments