docs: sync consolidation and session starter
This commit is contained in:
61
docs/standards/DOCS_STYLE_GUIDE.md
Normal file
61
docs/standards/DOCS_STYLE_GUIDE.md
Normal file
@@ -0,0 +1,61 @@
|
||||
# Docs Style Guide
|
||||
|
||||
Date: 2026-02-16
|
||||
Purpose: standardized writing and structure for canonical documentation in this repository.
|
||||
|
||||
## Scope
|
||||
|
||||
This guide applies to canonical docs in:
|
||||
- `docs/`
|
||||
- `docs/runbooks/`
|
||||
- `config/*.md`
|
||||
- root operational docs (`PROJECT-MASTER-INDEX.md`, `NODA1-SAFE-DEPLOY.md`, `NODA1-README.md`)
|
||||
|
||||
Legacy and snapshot docs are excluded from strict linting:
|
||||
- `docs/consolidation/_node1_runtime_docs/`
|
||||
- `.worktrees/`
|
||||
- backup artifacts (`*.bak_*`)
|
||||
|
||||
## Required Structure
|
||||
|
||||
Every new canonical document should start with:
|
||||
1. H1 title
|
||||
2. `Date: YYYY-MM-DD`
|
||||
3. `Purpose: ...`
|
||||
|
||||
Recommended sections:
|
||||
1. Scope
|
||||
2. Preconditions
|
||||
3. Procedure / Steps
|
||||
4. Verification
|
||||
5. Rollback / Recovery
|
||||
|
||||
## Writing Rules
|
||||
|
||||
- Use sentence-case headings.
|
||||
- Keep sections short and operational.
|
||||
- Prefer explicit paths and commands.
|
||||
- Mark runtime facts with concrete dates.
|
||||
- Avoid mixing strategic legacy notes into canonical runbooks.
|
||||
|
||||
## Naming Rules
|
||||
|
||||
- Runbooks: `docs/runbooks/<TOPIC>_RUNBOOK.md`
|
||||
- Decisions: `docs/runbooks/<TOPIC>_DECISION_YYYY-MM-DD.md`
|
||||
- One-off status snapshots: include date in filename.
|
||||
|
||||
## Linting
|
||||
|
||||
Local check:
|
||||
```bash
|
||||
bash scripts/docs/docs_lint.sh
|
||||
```
|
||||
|
||||
CI check:
|
||||
- GitHub workflow: `.github/workflows/docs-lint.yml`
|
||||
|
||||
Lint scope source:
|
||||
- `docs/standards/lint_scope.txt`
|
||||
|
||||
Note:
|
||||
- Full historical docs migration is phased; lint is enforced on managed canonical scope first.
|
||||
37
docs/standards/DOC_TEMPLATE.md
Normal file
37
docs/standards/DOC_TEMPLATE.md
Normal file
@@ -0,0 +1,37 @@
|
||||
# <Document Title>
|
||||
|
||||
Date: YYYY-MM-DD
|
||||
Purpose: one-sentence objective of this document.
|
||||
|
||||
## Scope
|
||||
|
||||
- Systems, repos, services, and files covered.
|
||||
|
||||
## Preconditions
|
||||
|
||||
- Required access
|
||||
- Required tools
|
||||
- Required environment
|
||||
|
||||
## Procedure
|
||||
|
||||
1. Step one
|
||||
2. Step two
|
||||
3. Step three
|
||||
|
||||
## Verification
|
||||
|
||||
- Command(s):
|
||||
```bash
|
||||
# put verification commands here
|
||||
```
|
||||
- Expected result(s)
|
||||
|
||||
## Rollback
|
||||
|
||||
1. Recovery step one
|
||||
2. Recovery step two
|
||||
|
||||
## References
|
||||
|
||||
- `/absolute/or/repo/path/to/relevant/file`
|
||||
7
docs/standards/lint_scope.txt
Normal file
7
docs/standards/lint_scope.txt
Normal file
@@ -0,0 +1,7 @@
|
||||
docs/SESSION_STARTER.md
|
||||
docs/consolidation/README.md
|
||||
docs/consolidation/SOURCES.md
|
||||
docs/runbooks/DOCS_SERVICES_AUTOMATION_RUNBOOK.md
|
||||
docs/standards/DOCS_STYLE_GUIDE.md
|
||||
docs/standards/DOC_TEMPLATE.md
|
||||
config/README.md
|
||||
Reference in New Issue
Block a user