docs: fill documentation gaps — MEMORY.md, secret sync, README generation
Some checks failed
CI / skinny-install (aco) (push) Successful in 51s
CI / skinny-install (bls) (push) Successful in 28s
CI / skinny-install (ccw) (push) Successful in 26s
CI / skinny-install (opps) (push) Successful in 29s
CI / lint-test (push) Successful in 1m12s
CI / skinny-install (api) (push) Successful in 26s
CI / skinny-install (bcda) (push) Successful in 27s
CI / skinny-install (bib) (push) Successful in 30s
CI / skinny-install (cms) (push) Successful in 28s
CI / skinny-install (cli) (push) Successful in 37s
CI / skinny-install (rex) (push) Successful in 35s
CI / skinny-install (api) (pull_request) Successful in 32s
CI / skinny-install (conf) (push) Successful in 32s
CI / skinny-install (perf) (push) Successful in 29s
CI / skinny-install (pfs) (push) Successful in 36s
CI / skinny-install (aco) (pull_request) Successful in 45s
CI / lint-test (pull_request) Successful in 1m16s
CI / skinny-install (bib) (pull_request) Successful in 32s
CI / skinny-install (bls) (pull_request) Successful in 28s
CI / skinny-install (ccw) (pull_request) Successful in 29s
CI / skinny-install (cli) (pull_request) Successful in 34s
CI / skinny-install (perf) (pull_request) Successful in 38s
CI / skinny-install (pfs) (pull_request) Successful in 30s
Infra CI / api (pull_request) Successful in 9s
Infra CI / mc (pull_request) Successful in 6s
CI / skinny-install (bcda) (pull_request) Successful in 36s
CI / skinny-install (cms) (pull_request) Successful in 27s
CI / skinny-install (conf) (pull_request) Successful in 29s
CI / skinny-install (opps) (pull_request) Successful in 29s
Infra CI / notebooks (pull_request) Successful in 7s
Infra CI / zotero (pull_request) Successful in 6s
CI / skinny-install (rex) (pull_request) Successful in 27s
Infra CI / docs (pull_request) Failing after 5s
Some checks failed
CI / skinny-install (aco) (push) Successful in 51s
CI / skinny-install (bls) (push) Successful in 28s
CI / skinny-install (ccw) (push) Successful in 26s
CI / skinny-install (opps) (push) Successful in 29s
CI / lint-test (push) Successful in 1m12s
CI / skinny-install (api) (push) Successful in 26s
CI / skinny-install (bcda) (push) Successful in 27s
CI / skinny-install (bib) (push) Successful in 30s
CI / skinny-install (cms) (push) Successful in 28s
CI / skinny-install (cli) (push) Successful in 37s
CI / skinny-install (rex) (push) Successful in 35s
CI / skinny-install (api) (pull_request) Successful in 32s
CI / skinny-install (conf) (push) Successful in 32s
CI / skinny-install (perf) (push) Successful in 29s
CI / skinny-install (pfs) (push) Successful in 36s
CI / skinny-install (aco) (pull_request) Successful in 45s
CI / lint-test (pull_request) Successful in 1m16s
CI / skinny-install (bib) (pull_request) Successful in 32s
CI / skinny-install (bls) (pull_request) Successful in 28s
CI / skinny-install (ccw) (pull_request) Successful in 29s
CI / skinny-install (cli) (pull_request) Successful in 34s
CI / skinny-install (perf) (pull_request) Successful in 38s
CI / skinny-install (pfs) (pull_request) Successful in 30s
Infra CI / api (pull_request) Successful in 9s
Infra CI / mc (pull_request) Successful in 6s
CI / skinny-install (bcda) (pull_request) Successful in 36s
CI / skinny-install (cms) (pull_request) Successful in 27s
CI / skinny-install (conf) (pull_request) Successful in 29s
CI / skinny-install (opps) (pull_request) Successful in 29s
Infra CI / notebooks (pull_request) Successful in 7s
Infra CI / zotero (pull_request) Successful in 6s
CI / skinny-install (rex) (pull_request) Successful in 27s
Infra CI / docs (pull_request) Failing after 5s
- MEMORY.md: update milestone count (32 milestones, 29 closed), fix pipe layer stats (14 pipelines, 230 steps), add key files (sem, lake, j2), add sem module and Databricks SDK sections with memory file pointers - project_sem_module.md: new memory file for semantic coverage architecture - project_databricks_sdk.md: new memory file for 18-service SDK integration - README.md.j2: add README generation section with gen_readme.py usage, expand secret sync section with --list flag and description - Regenerate README.md (12,320 tests)
This commit is contained in:
15
README.md
15
README.md
@@ -330,9 +330,12 @@ status = mgr.get_run_status(run_id)
|
|||||||
|
|
||||||
### Secret sync
|
### Secret sync
|
||||||
|
|
||||||
|
Push environment variables to Databricks secret scopes per `stack.toml [databricks.secrets]`:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
uv run python dev/scripts/sync_secrets.py --dry-run # preview
|
uv run python dev/scripts/sync_secrets.py --dry-run # preview
|
||||||
uv run python dev/scripts/sync_secrets.py # push to Databricks
|
uv run python dev/scripts/sync_secrets.py # push to Databricks
|
||||||
|
uv run python dev/scripts/sync_secrets.py --list # show current secrets
|
||||||
```
|
```
|
||||||
|
|
||||||
### Quality monitoring
|
### Quality monitoring
|
||||||
@@ -451,6 +454,18 @@ uv run python -m pytest tests/ -m stub # only stub status
|
|||||||
uv run python -m pytest tests/test_ast_coverage.py # structural invariants only
|
uv run python -m pytest tests/test_ast_coverage.py # structural invariants only
|
||||||
```
|
```
|
||||||
|
|
||||||
|
### README generation
|
||||||
|
|
||||||
|
`README.md` is generated from `README.md.j2` using live codebase data. Never edit `README.md` directly.
|
||||||
|
|
||||||
|
```bash
|
||||||
|
uv run python dev/scripts/gen_readme.py # regenerate from template
|
||||||
|
uv run python dev/scripts/gen_readme.py --check # verify freshness (CI gate)
|
||||||
|
uv run python dev/scripts/gen_readme.py --dry-run # preview to stdout
|
||||||
|
```
|
||||||
|
|
||||||
|
Dynamic values pulled from: `compose.yml` (services), `pyproject.toml` (modules), pipeline registry (pipelines + steps), `pytest --collect-only` (test count), `api.auth.manifest` (credentials), `.gitea/workflows/` (workflow count).
|
||||||
|
|
||||||
## Project layout
|
## Project layout
|
||||||
|
|
||||||
```
|
```
|
||||||
|
|||||||
15
README.md.j2
15
README.md.j2
@@ -323,9 +323,12 @@ status = mgr.get_run_status(run_id)
|
|||||||
|
|
||||||
### Secret sync
|
### Secret sync
|
||||||
|
|
||||||
|
Push environment variables to Databricks secret scopes per `stack.toml [databricks.secrets]`:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
uv run python dev/scripts/sync_secrets.py --dry-run # preview
|
uv run python dev/scripts/sync_secrets.py --dry-run # preview
|
||||||
uv run python dev/scripts/sync_secrets.py # push to Databricks
|
uv run python dev/scripts/sync_secrets.py # push to Databricks
|
||||||
|
uv run python dev/scripts/sync_secrets.py --list # show current secrets
|
||||||
```
|
```
|
||||||
|
|
||||||
### Quality monitoring
|
### Quality monitoring
|
||||||
@@ -444,6 +447,18 @@ uv run python -m pytest tests/ -m stub # only stub status
|
|||||||
uv run python -m pytest tests/test_ast_coverage.py # structural invariants only
|
uv run python -m pytest tests/test_ast_coverage.py # structural invariants only
|
||||||
```
|
```
|
||||||
|
|
||||||
|
### README generation
|
||||||
|
|
||||||
|
`README.md` is generated from `README.md.j2` using live codebase data. Never edit `README.md` directly.
|
||||||
|
|
||||||
|
```bash
|
||||||
|
uv run python dev/scripts/gen_readme.py # regenerate from template
|
||||||
|
uv run python dev/scripts/gen_readme.py --check # verify freshness (CI gate)
|
||||||
|
uv run python dev/scripts/gen_readme.py --dry-run # preview to stdout
|
||||||
|
```
|
||||||
|
|
||||||
|
Dynamic values pulled from: `compose.yml` (services), `pyproject.toml` (modules), pipeline registry (pipelines + steps), `pytest --collect-only` (test count), `api.auth.manifest` (credentials), `.gitea/workflows/` (workflow count).
|
||||||
|
|
||||||
## Project layout
|
## Project layout
|
||||||
|
|
||||||
```
|
```
|
||||||
|
|||||||
Reference in New Issue
Block a user