[docs] CI, demo script, README polish #3

Closed
opened 2026-10-23 21:25:25 -05:00 by nicolas_naranjo · 1 comment
Owner

status: tracking issue for the docs agent.

Scope:

  • docs/demo.md — contest demo script (3 end-to-end FA scenarios, click-paths per docs/design.md)
  • README polish (features/quickstart) + <!-- TODO(screenshots) --> placeholder (deferred until web PR merges)
  • docs/index.md: link demo page (minimal edit)
  • .forgejo/workflows/ci.yaml: robust rust job (cargo caching via actions/cache), keep fmt/clippy/test; web job untouched; document runner-label assumption
  • deploy/README.md: align OpenBao/ESO wording with docs/CONTRACT.md env section
  • tern run + commit regenerated docs-html/ with every docs change

Branch: agent/docs. Deferred: screenshots (after web PR).

status: tracking issue for the docs agent. Scope: - `docs/demo.md` — contest demo script (3 end-to-end FA scenarios, click-paths per `docs/design.md`) - README polish (features/quickstart) + `<!-- TODO(screenshots) -->` placeholder (deferred until web PR merges) - `docs/index.md`: link demo page (minimal edit) - `.forgejo/workflows/ci.yaml`: robust rust job (cargo caching via actions/cache), keep fmt/clippy/test; web job untouched; document runner-label assumption - `deploy/README.md`: align OpenBao/ESO wording with `docs/CONTRACT.md` env section - tern run + commit regenerated `docs-html/` with every docs change Branch: `agent/docs`. Deferred: screenshots (after web PR).
Author
Owner

status: done — PR #7 open against master (branch agent/docs).

  • ✅ docs/demo.md — 3 scenarios as click-paths (regex→NFA→DFA→min+trace / union / complement+render), mermaid diagrams, surfaces per design.md
  • ✅ docs/index.md — demo link (one line)
  • ✅ README — features/quickstart sharpened; TODO(screenshots) section in place
  • ✅ ci.yaml — cargo registry/target caching via actions/cache, runner-label assumption documented; web job untouched
  • ✅ deploy/README.md — OpenBao/ESO item aligned with CONTRACT env vars (secrets-only via ExternalSecret)
  • ✅ tern exit 0, 5 files converted, docs-html/demo.html rendered + committed

Deferred: web UI screenshots (README placeholder) — land after the web PR merges.
Open: runner-label question → #4 (addressed to [infra]).
Will close this issue when PR #7 merges.

status: done — PR #7 open against `master` (branch `agent/docs`). - ✅ `docs/demo.md` — 3 scenarios as click-paths (regex→NFA→DFA→min+trace / union / complement+render), mermaid diagrams, surfaces per design.md - ✅ `docs/index.md` — demo link (one line) - ✅ README — features/quickstart sharpened; `TODO(screenshots)` section in place - ✅ `ci.yaml` — cargo registry/target caching via actions/cache, runner-label assumption documented; web job untouched - ✅ `deploy/README.md` — OpenBao/ESO item aligned with CONTRACT env vars (secrets-only via ExternalSecret) - ✅ tern exit 0, 5 files converted, `docs-html/demo.html` rendered + committed Deferred: **web UI screenshots** (README placeholder) — land after the web PR merges. Open: runner-label question → #4 (addressed to [infra]). Will close this issue when PR #7 merges.
Sign in to join this conversation.
No labels
No milestone
No project
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set

Reference
k8s-services/rgxr#3
No description provided.