390d03625e
* documentation writing skill * visa sponsors page * overview * in progress board * settings * reactive resume section * database backups * workflows * post application tracking flow * manual tracking caveats * pricing section * pipeline run detalis * job search bar * keyboard shortcuts * bulk actions * no informal phrasing * formatting * build fix? * Update docs-site/docs/features/overview.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Update docs-site/versioned_docs/version-0.1.20/features/orchestrator.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Update docs-site/docs/features/visa-sponsors.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Update docs-site/docs/features/in-progress-board.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * remove link to page that don't exist --------- Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
37 lines
873 B
Markdown
37 lines
873 B
Markdown
---
|
|
id: documentation-style-guide
|
|
title: Documentation Style Guide
|
|
description: Standards for writing user-facing docs in this repository.
|
|
sidebar_position: 2
|
|
---
|
|
|
|
Use this structure for feature pages:
|
|
|
|
1. **What it is**
|
|
2. **Why it exists**
|
|
3. **How to use it**
|
|
4. **Common problems**
|
|
5. **Related pages**
|
|
|
|
## Frontmatter requirements
|
|
|
|
Every doc should include:
|
|
|
|
- `id`
|
|
- `title`
|
|
- `description`
|
|
- `sidebar_position`
|
|
|
|
## Writing rules
|
|
|
|
- Prefer concrete steps over abstract prose.
|
|
- Provide copy-pasteable examples.
|
|
- State defaults and constraints explicitly.
|
|
- Use absolute `/docs/...` URLs and include the version segment when needed.
|
|
- For current docs, use `/docs/next/...` links.
|
|
- For versioned docs, link within that version (for example `/docs/...` in `version-0.1.20`).
|
|
|
|
## PR expectations
|
|
|
|
Any user-visible behavior change should include matching docs updates.
|