[docs] demo script, CI cargo caching, README polish #7

Merged
nicolas_naranjo merged 1 commit from agent/docs into master 2026-10-23 21:45:13 -05:00
Owner

Fulfills the [agent] docs brief in docs/TASKS.md. Closes nothing yet; tracking issue #3 (closes on merge).

What changed

  • docs/demo.md (new) — the contest demo script: 3 end-to-end FA scenarios written as exact presenter click-paths, referencing UI surfaces from docs/design.md (tabs EDITOR/OPS/REGEX/SAVED, RUN_PANEL, status bar, bracketed buttons):
    1. (a|b)*abb: regex→NFA→DFA→minimize, run ababb with step trace → [ ACCEPTED ]
    2. union of two saved DFAs + traced runs (incl. empty-string edge case)
    3. complement (with a deliberate 400 invalid_fa beat on an NFA) + SVG render via the fast engine
      Includes 2 mermaid diagrams and a "if something goes wrong" talk-track table.
  • docs/index.md — one line: demo page link under "In this documentation". No other edits to frozen docs.
  • README.md — features list sharpened (8 items with real semantics), quickstart now covers the web dev server (:5173, proxied to :8080) until the compose web service lands, plus a clearly-marked <!-- TODO(screenshots) --> placeholder section.
  • .forgejo/workflows/ci.yaml — rust job: added actions/cache@v4 for cargo registry/git checkouts + workspace target, keyed on Cargo.lock (Forgejo actions cache server, works inside container jobs). fmt/clippy/test steps unchanged. Header comment now documents the runner-label assumption and points at the question issue. Web job untouched, no job restructuring.
  • deploy/README.md — OpenBao/ESO checklist item aligned with docs/CONTRACT.md § Environment variables: full var list referenced; only secret-bearing values (DATABASE_URL credentials) flow through ExternalSecret → K8s Secret; RGXR_*/RUST_LOG noted as plain chart values. No new infra commitments.
  • docs-html/ — regenerated by tern in the same commit (demo.html added, index.html link). Never hand-edited.

Gate results

  • No Rust or web changes → no cargo/bun runs (per brief).
  • tern exit 0 — Build Summary: 1/1 pipeline succeeded; 5 files converted; rendered docs-html/demo.html contains all three scenarios; both mermaid blocks present; index.html links the new page.

Open question / decisions

  • Runner label — #4 asks @infra to confirm the runner registers as runs-on: ubuntu-latest with a docker backend (jobs use container: images). If the label differs, this PR (or a follow-up) updates runs-on.
  • Deferred: web UI screenshots — land in the TODO(screenshots) README section after the web PR merges (noted in #3).
  • Worktree note for other agents: tern profiles live in the gitignored .tern/store.db; a fresh worktree has an empty one. Copy the main checkout's store.db (e.g. sqlite backup) before running tern there, else the TUI opens with no profile. Not a repo change — mentioning it here for whoever hits it next.
Fulfills the `[agent] docs` brief in `docs/TASKS.md`. Closes nothing yet; tracking issue #3 (closes on merge). ## What changed - **`docs/demo.md`** (new) — the contest demo script: 3 end-to-end FA scenarios written as exact presenter click-paths, referencing UI surfaces from `docs/design.md` (tabs `EDITOR/OPS/REGEX/SAVED`, `RUN_PANEL`, status bar, bracketed buttons): 1. `(a|b)*abb`: regex→NFA→DFA→minimize, run `ababb` with step trace → `[ ACCEPTED ]` 2. union of two saved DFAs + traced runs (incl. empty-string edge case) 3. complement (with a deliberate `400 invalid_fa` beat on an NFA) + SVG render via the fast engine Includes 2 mermaid diagrams and a "if something goes wrong" talk-track table. - **`docs/index.md`** — one line: demo page link under "In this documentation". No other edits to frozen docs. - **`README.md`** — features list sharpened (8 items with real semantics), quickstart now covers the web dev server (`:5173`, proxied to `:8080`) until the compose `web` service lands, plus a clearly-marked `<!-- TODO(screenshots) -->` placeholder section. - **`.forgejo/workflows/ci.yaml`** — rust job: added `actions/cache@v4` for cargo registry/git checkouts + workspace `target`, keyed on `Cargo.lock` (Forgejo actions cache server, works inside container jobs). fmt/clippy/test steps unchanged. Header comment now documents the runner-label assumption and points at the question issue. Web job untouched, no job restructuring. - **`deploy/README.md`** — OpenBao/ESO checklist item aligned with `docs/CONTRACT.md` § Environment variables: full var list referenced; only secret-bearing values (`DATABASE_URL` credentials) flow through `ExternalSecret` → K8s Secret; `RGXR_*`/`RUST_LOG` noted as plain chart values. No new infra commitments. - **`docs-html/`** — regenerated by `tern` in the same commit (`demo.html` added, `index.html` link). Never hand-edited. ## Gate results - No Rust or web changes → no cargo/bun runs (per brief). - `tern` exit **0** — `Build Summary: 1/1 pipeline succeeded; 5 files converted`; rendered `docs-html/demo.html` contains all three scenarios; both mermaid blocks present; `index.html` links the new page. ## Open question / decisions - **Runner label** — #4 asks @infra to confirm the runner registers as `runs-on: ubuntu-latest` with a docker backend (jobs use `container:` images). If the label differs, this PR (or a follow-up) updates `runs-on`. - **Deferred:** web UI screenshots — land in the `TODO(screenshots)` README section after the web PR merges (noted in #3). - **Worktree note for other agents:** tern profiles live in the gitignored `.tern/store.db`; a fresh worktree has an empty one. Copy the main checkout's store.db (e.g. sqlite backup) before running `tern` there, else the TUI opens with no profile. Not a repo change — mentioning it here for whoever hits it next.
docs: demo script, CI caching + runner-label note, README polish
Some checks failed
ci / rust (pull_request) Failing after 30s
ci / web (pull_request) Successful in 10m7s
d3a90a3bef
- docs/demo.md: contest demo — 3 end-to-end FA scenarios as exact
  click-paths (regex→NFA→DFA→minimize+trace, union of two DFAs,
  complement+render), surfaces per docs/design.md, mermaid diagrams
- docs/index.md: link the demo page
- README.md: sharpened features/quickstart, TODO(screenshots) section
- ci.yaml: cache cargo registry/git/target via actions/cache, document
  the runner-label assumption (issue #4); web job untouched
- deploy/README.md: align OpenBao/ESO item with CONTRACT env section
- docs-html/: regenerated via tern (demo.html added, index.html link)
nicolas_naranjo deleted branch agent/docs 2026-10-23 21:45:13 -05:00
Sign in to join this conversation.
No reviewers
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!7
No description provided.