Create the setup for the documentation page (#171)
* don't run for generated docusaurus * format * workflow to autoupdate docs version * fix versioning * add link back to app * remove old docs * html link??? * don't track .docusaurus * documantation build
This commit is contained in:
@@ -0,0 +1,34 @@
|
||||
---
|
||||
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.
|
||||
- Link related docs using `/docs/...` URLs.
|
||||
|
||||
## PR expectations
|
||||
|
||||
Any user-visible behavior change should include matching docs updates.
|
||||
@@ -0,0 +1,26 @@
|
||||
---
|
||||
id: faq
|
||||
title: FAQ
|
||||
description: Frequently asked questions about deployment, docs, and operations.
|
||||
sidebar_position: 1
|
||||
---
|
||||
|
||||
## Is docs content bundled for self-hosted installs?
|
||||
|
||||
Yes. The docs static build is bundled and served locally at `/docs`.
|
||||
|
||||
## Do I need internet access to read docs after deployment?
|
||||
|
||||
No, for bundled docs pages.
|
||||
|
||||
## How are docs versions managed?
|
||||
|
||||
Docs are versioned using Docusaurus versions, intended to map to release tags.
|
||||
|
||||
## Where should contributors edit docs?
|
||||
|
||||
Edit files under `docs-site/docs` for latest docs.
|
||||
|
||||
## Are old markdown files in `documentation/` still canonical?
|
||||
|
||||
No. `docs-site/docs` is the source of truth after migration.
|
||||
Reference in New Issue
Block a user