formatting
This commit is contained in:
@@ -24,38 +24,38 @@ Use this as a compact reference for Zensical mechanics and as the place to recor
|
||||
|
||||
Open only what you need:
|
||||
|
||||
- Official docs and source map: [./references/index.md](./references/index.md)
|
||||
- Zensical feature catalog and setup links: [./references/zensical-features.md](./references/zensical-features.md)
|
||||
- Theme, icons, and visual customization: [./references/theme-customization-and-icons.md](./references/theme-customization-and-icons.md)
|
||||
- Writing quality and review criteria: [./references/documentation-quality.md](./references/documentation-quality.md)
|
||||
- Navigation and discoverability patterns: [./references/discoverability-and-ia.md](./references/discoverability-and-ia.md)
|
||||
- Code-heavy docs and API reference patterns: [./references/code-heavy-docs-and-mkdocstrings.md](./references/code-heavy-docs-and-mkdocstrings.md)
|
||||
- Official docs and source map: [source map](./references/index.md)
|
||||
- Zensical feature catalog and setup links: [feature catalog](./references/zensical-features.md)
|
||||
- Theme, icons, and visual customization: [theme customization](./references/theme-customization-and-icons.md)
|
||||
- Writing quality and review criteria: [documentation quality](./references/documentation-quality.md)
|
||||
- Navigation and discoverability patterns: [discoverability and IA](./references/discoverability-and-ia.md)
|
||||
- Code-heavy docs and API reference patterns: [code-heavy docs](./references/code-heavy-docs-and-mkdocstrings.md)
|
||||
|
||||
## Common Cases
|
||||
|
||||
### New docs project
|
||||
|
||||
- Start with `uv run zensical new`.
|
||||
- Then review [./references/index.md](./references/index.md) and [./references/zensical-features.md](./references/zensical-features.md).
|
||||
- Then review the [source map](./references/index.md) and [feature catalog](./references/zensical-features.md).
|
||||
|
||||
### Restructuring docs or navigation
|
||||
|
||||
- Review [./references/discoverability-and-ia.md](./references/discoverability-and-ia.md).
|
||||
- Review [discoverability and IA](./references/discoverability-and-ia.md).
|
||||
- Use it to decide overview pages, section structure, and cross-linking.
|
||||
|
||||
### Improving writing quality
|
||||
|
||||
- Review [./references/documentation-quality.md](./references/documentation-quality.md).
|
||||
- Review [documentation quality](./references/documentation-quality.md).
|
||||
- Use it for page quality gates, trust signals, and review criteria.
|
||||
|
||||
### Adjusting theme or UI mechanics
|
||||
|
||||
- Review [./references/theme-customization-and-icons.md](./references/theme-customization-and-icons.md).
|
||||
- Review [theme customization](./references/theme-customization-and-icons.md).
|
||||
- Use it for icons, color, theme extensions, and presentation choices.
|
||||
|
||||
### Documenting APIs or code-heavy systems
|
||||
|
||||
- Review [./references/code-heavy-docs-and-mkdocstrings.md](./references/code-heavy-docs-and-mkdocstrings.md).
|
||||
- Review [code-heavy docs](./references/code-heavy-docs-and-mkdocstrings.md).
|
||||
- Use it when generated API reference belongs alongside hand-authored docs.
|
||||
|
||||
## Preferences To Maintain Here
|
||||
|
||||
Reference in New Issue
Block a user