docs: sync consolidation and session starter

This commit is contained in:
Apple
2026-02-16 02:25:54 -08:00
parent 798c6f88c7
commit 7df8cd5882
18 changed files with 345 additions and 6 deletions

View File

@@ -46,6 +46,17 @@ bash scripts/docs/services_sync.sh --dry-run
bash scripts/docs/services_sync.sh --apply
```
5. Docs lint and standards:
```bash
bash scripts/docs/docs_lint.sh
```
6. Docs backup (explicit run):
```bash
bash scripts/docs/docs_backup.sh --dry-run
bash scripts/docs/docs_backup.sh --apply
```
## Runtime-First Facts (must re-check each session)
1. NODE1 branch/SHA:

1
docs/backups/LATEST.txt Normal file
View File

@@ -0,0 +1 @@
/Users/apple/github-projects/microdao-daarion/docs/backups/docs_backup_20260216-022549.tar.gz

View File

@@ -1,6 +1,6 @@
# Integrations Bootstrap Status
Generated: 2026-02-16 10:20:19 UTC
Generated: 2026-02-16 10:25:49 UTC
Repo: /Users/apple/github-projects/microdao-daarion

View File

@@ -32,5 +32,8 @@ python3 /Users/apple/github-projects/microdao-daarion/scripts/docs/build_docs_hu
```bash
bash /Users/apple/github-projects/microdao-daarion/scripts/docs/session_bootstrap.sh
bash /Users/apple/github-projects/microdao-daarion/scripts/docs/services_sync.sh --dry-run
bash /Users/apple/github-projects/microdao-daarion/scripts/docs/services_sync.sh --apply
bash /Users/apple/github-projects/microdao-daarion/scripts/docs/docs_lint.sh
bash /Users/apple/github-projects/microdao-daarion/scripts/docs/docs_sync.sh --dry-run
```

View File

@@ -24,6 +24,8 @@ This file tracks where documentation is collected from for consolidation.
## Automation Scripts
- `scripts/docs/session_bootstrap.sh` — refreshes integration status and writes `INTEGRATIONS_STATUS_LATEST.md`.
- `scripts/docs/docs_sync.sh` — safe docs sync automation with `--dry-run` by default and explicit `--apply`.
- `scripts/docs/docs_lint.sh` — markdown lint for canonical documentation.
- `scripts/docs/docs_backup.sh` — timestamped docs backup with retention rotation.
- `scripts/docs/jupyter_sync.sh` — adapter for Jupyter server API status + notebooks index export.
- `scripts/docs/pieces_sync.sh` — adapter for Pieces local runtime/data index + optional API probe.
- `scripts/docs/services_sync.sh` — orchestrator for bootstrap + Jupyter + Pieces sync adapters.

View File

@@ -1,6 +1,6 @@
# Jupyter Sync Report
Generated: 2026-02-16 10:20:20 UTC
Generated: 2026-02-16 10:25:50 UTC
- jupyter_cmd: not-found
- server_count: 0

View File

@@ -1,6 +1,6 @@
# Pieces Sync Report
Generated: 2026-02-16 10:20:43 UTC
Generated: 2026-02-16 10:25:50 UTC
- pieces_extensions_count: 1
- pieces_data_dirs_count: 0

View File

@@ -43,6 +43,7 @@ Outputs:
- `docs/consolidation/jupyter/notebooks_index_latest.csv`
- `docs/consolidation/pieces/PIECES_SYNC_LATEST.md`
- `docs/consolidation/pieces/pieces_index_latest.csv`
- `docs/backups/LATEST.txt` (latest backup archive reference)
## 3) Review pending docs updates
@@ -64,6 +65,24 @@ bash scripts/docs/docs_sync.sh --apply --targets github,gitea
- `docs_sync.sh` is dry-run by default.
- `--apply` refuses to proceed if staged non-doc files are present.
- Only curated doc paths are auto-staged by the script.
- `services_sync.sh --apply` creates docs backup before writing integration artifacts.
## Standardization and lint
Local lint:
```bash
cd /Users/apple/github-projects/microdao-daarion
bash scripts/docs/docs_lint.sh
```
CI lint:
- `.github/workflows/docs-lint.yml`
- config: `.markdownlint.yml`, `.markdownlintignore`
Style and template:
- `docs/standards/DOCS_STYLE_GUIDE.md`
- `docs/standards/DOC_TEMPLATE.md`
## Jupyter and Pieces notes

View 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.

View 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`

View 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