Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions .github/workflows/docs-index.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
name: docs-index-fresh
on:
push:
paths: ['docs/contract-additions/**', 'docs/surfaces/README.md', 'tools/build_docs_index.py', 'docs/surfaces/data/docs-index.json']
pull_request:
paths: ['docs/contract-additions/**', 'docs/surfaces/README.md', 'tools/build_docs_index.py', 'docs/surfaces/data/docs-index.json']
jobs:
fresh:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/setup-python@v5
with: { python-version: '3.11' }
- name: Regenerate the grounded docs index from source
run: python tools/build_docs_index.py
- name: Fail if the committed index drifted from source
run: |
if ! git diff --exit-code docs/surfaces/data/docs-index.json; then
echo "::error::docs-index.json is stale — run tools/build_docs_index.py and commit"; exit 1
fi
3 changes: 3 additions & 0 deletions docs/surfaces/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,9 @@ the real SociOS/GNOME chrome (top bar, launcher card) so they read as in-shell,
- **`lampstand-launcher.html`** — Tier 2, *actionable*. The Spotlight replacement: natural
language → typed intents/entities/relations (the annotation tree) → **governed actions**
(purpose-bound, consent-gated, receipted), ranked by sherlock (IR). Not web search — typed acts.
- **`docs-support.html`** — Tier 2, *grounded NLQA + support*. Answers only from the
auto-generated docs index (`tools/build_docs_index.py`), cites every source, and **abstains**
to support when a question isn't in the docs. A CI drift-guard keeps the index fresh from source.
- **`model-governance.html`** — Tier 2, *regulated model registry*. Business targets (fraud/churn/
credit/AML/propensity) with champion-vs-challenger, historic version comparison, PSI drift, and the
DataClass classifiers per target. Model risk management as a witness surface.
Expand Down
Loading
Loading