docs: reconcile docs after ci+website merges; gitignore wrangler/vscode
Post-merge documentation accuracy pass (CI and website branches both merged to main; website deployed). - CLAUDE.md: rewrite the stale repository-layout tree; add a Website & docs-site decision bullet (Astro+Starlight, Cloudflare Pages via Gitea Actions, ADR-website-001, the website branch stays open); update the CI note (merged to main; release-macos dispatchable + verified working). - requirements.md: D1 — macOS targets now runtime-verified (release-macos dispatched end-to-end); DOC1 — canonical user docs now live on the deployed website. - ADR-ci-003 (+ docs/ci/adr README): Amendment 2 — CI on main, release-macos dispatched + verified; macOS runtime-verified. - docs/website/adr README: drop the stale "no CI yet". - .gitignore: ignore .wrangler/ (Cloudflare Wrangler cache) and .vscode/; remove the tracked website/.vscode/ an Astro template had added. D3 (package-manager manifests) + some install instructions remain open.
This commit is contained in:
claude@clouddev1
@@ -108,10 +108,11 @@ Current decisions at a glance (each backed by an ADR):
|
||||
SQL `select` / `with` / `insert` / `update` / `delete`
|
||||
(ADR-0039). `EXPLAIN QUERY PLAN` never executes, so
|
||||
explaining a destructive command is safe.
|
||||
- **Continuous integration & release** (built on the `ci` branch,
|
||||
2026-06-15; decisions in `docs/ci/adr/` — **ADR-ci-001/002/003**,
|
||||
a namespace kept separate from the main ADR sequence to avoid
|
||||
cross-branch number collisions, like the website's): a self-hosted
|
||||
- **Continuous integration & release** (developed on the `ci` branch,
|
||||
**merged to `main` 2026-06-15**; decisions in `docs/ci/adr/` —
|
||||
**ADR-ci-001/002/003**, a namespace kept separate from the main ADR
|
||||
sequence to avoid cross-branch number collisions, like the website's):
|
||||
a self-hosted
|
||||
**Gitea Actions** pipeline built on a **nix flake** (pinned Rust
|
||||
`1.95.0` — one source of toolchain for dev *and* CI) plus a
|
||||
prebuilt CI image. **Gate** (`ci.yaml`): `clippy -D warnings` +
|
||||
@@ -122,44 +123,72 @@ Current decisions at a glance (each backed by an ADR):
|
||||
`release-macos.yaml` on a Tart Apple-Silicon runner (de-nix the
|
||||
`libiconv` load path + ad-hoc re-sign). All published to a Gitea
|
||||
release with `.sha256`s. **`fmt` is intentionally not gated yet**
|
||||
(the tree isn't stock-`rustfmt`-clean). `workflow_dispatch` is
|
||||
Gitea-default-branch-only, so `release-macos` is dispatchable once
|
||||
this lands on `main`.
|
||||
(the tree isn't stock-`rustfmt`-clean). Now that this is on `main`,
|
||||
`release-macos` is dispatchable (`workflow_dispatch` is
|
||||
Gitea-default-branch-only) — **dispatched and verified working**: the
|
||||
macOS build + de-nix/re-sign + upload runs end-to-end and the binaries
|
||||
launch.
|
||||
- **Website & docs site** (developed on the `website` branch, **merged
|
||||
to `main`**; the branch **stays open** for future staging deploys;
|
||||
decisions in `docs/website/adr/` — **ADR-website-001**, its own
|
||||
namespace like CI's): an **Astro + Starlight + Tailwind** marketing
|
||||
landing page plus the **canonical** user docs, under `website/`.
|
||||
Showcase demos are **asciinema casts** (a scripted-input driver, paced
|
||||
+ re-recordable — *not* `history.log` replay; the `--demo` overlay,
|
||||
ADR-0047, dresses them). **Deployed to Cloudflare Pages via Gitea
|
||||
Actions** (`.gitea/workflows/website.yaml`; the crate gate is skipped
|
||||
for website-only changes). Two copy rules bind user-facing text: **no
|
||||
engine name** (continues ADR-0002) and **no "DSL"** (say "simple mode"
|
||||
/ "advanced mode"). Install docs are still partial — package-manager
|
||||
manifests + some installation instructions are pending (`requirements.md`
|
||||
D3 / DOC1).
|
||||
|
||||
## Repository layout
|
||||
|
||||
```
|
||||
.
|
||||
├── Cargo.toml # dependencies, lints (nursery)
|
||||
├── CLAUDE.md # this file
|
||||
├── Cargo.toml / Cargo.lock # dependencies, lints (nursery)
|
||||
├── CLAUDE.md # this file
|
||||
├── flake.nix / flake.lock # pinned Rust toolchain, one source for dev + CI (ADR-ci-002)
|
||||
├── rust-toolchain.toml # toolchain pin
|
||||
├── .gitea/ # Gitea Actions workflows + prebuilt CI image (ADR-ci-001..003, website)
|
||||
├── ci/ # CI build helpers (e.g. winstub/ — Windows link stub)
|
||||
├── docs/
|
||||
│ ├── adr/ # all decision records (read 0000 first)
|
||||
│ ├── handoff/ # session-handover notes
|
||||
│ └── requirements.md # the Phase-1 checklist with progress
|
||||
│ ├── adr/ # project-wide decision records (read 0000 first)
|
||||
│ ├── ci/{adr,handoff}/ # CI subproject ADRs (ci-001..003) + handoffs
|
||||
│ ├── website/{adr,plans}/ # website subproject ADRs (website-001) + plan
|
||||
│ ├── handoff/ # session-handover notes
|
||||
│ ├── plans/ # working plans
|
||||
│ └── requirements.md # the Phase-1 checklist with progress
|
||||
├── src/
|
||||
│ ├── action.rs # Action enum (Quit / ExecuteDsl)
|
||||
│ ├── app.rs # App state + pure update() + Tier-1 tests
|
||||
│ ├── cli.rs # CLI args (--theme, --log-file)
|
||||
│ ├── db.rs # rusqlite worker, all DDL/DML, metadata tables
|
||||
│ ├── action.rs # Action enum (Quit / ExecuteDsl / …)
|
||||
│ ├── app.rs # App state + pure update() + Tier-1 tests
|
||||
│ ├── cli.rs # CLI args (--theme, --log-file, --demo, --no-undo, --resume, …)
|
||||
│ ├── clipboard.rs # copy output to the system clipboard
|
||||
│ ├── completion.rs # Tab completion + schema cache
|
||||
│ ├── db.rs # rusqlite worker, all DDL/DML, metadata tables
|
||||
│ ├── dsl/
|
||||
│ │ ├── action.rs # ReferentialAction enum + parsing
|
||||
│ │ ├── command.rs # Command AST + RelationshipSelector + RowFilter
|
||||
│ │ ├── mod.rs # re-exports
|
||||
│ │ ├── parser.rs # parse entry point → unified-grammar walker
|
||||
│ │ ├── shortid.rs # base58 generator + validator
|
||||
│ │ ├── types.rs # user-facing Type enum + fk_target_type
|
||||
│ │ └── value.rs # Value/Bound + per-type validation
|
||||
│ ├── event.rs # AppEvent (input + DSL outcomes)
|
||||
│ ├── lib.rs # module re-exports for tests
|
||||
│ ├── logging.rs # tracing setup, file-backed
|
||||
│ ├── main.rs # binary entry; thin
|
||||
│ ├── mode.rs # Simple/Advanced mode enum
|
||||
│ ├── runtime.rs # Tokio loop, terminal setup, dispatch
|
||||
│ ├── snapshots/ # insta snapshots for Tier-2 tests
|
||||
│ ├── theme.rs # light/dark themes
|
||||
│ └── ui.rs # ratatui rendering
|
||||
└── tests/
|
||||
└── walking_skeleton.rs # Tier-3 integration tests
|
||||
│ │ ├── grammar/ # hand-rolled unified grammar nodes (DSL + SQL)
|
||||
│ │ ├── walker/ # grammar walker (driver / context / highlight / outcome)
|
||||
│ │ ├── command.rs parser.rs types.rs value.rs action.rs shortid.rs sql_functions.rs
|
||||
│ ├── echo.rs # command echo / SQL rendering
|
||||
│ ├── event.rs # AppEvent (input + DSL outcomes)
|
||||
│ ├── friendly/ # friendly-error layer + string catalog (strings/en-US.yaml) + keys
|
||||
│ ├── input_render.rs # input-field render + ambient hint classification
|
||||
│ ├── output_render.rs # output-panel render helpers (incl. relationship diagrams)
|
||||
│ ├── logging.rs main.rs mode.rs runtime.rs # tracing / entry / mode enum / Tokio loop
|
||||
│ ├── persistence/ # csv + yaml + history IO + migrations
|
||||
│ ├── project/ # open/create, lock, naming, prettifier
|
||||
│ ├── seed/ # seed generators / heuristics / vocabulary (ADR-0048)
|
||||
│ ├── snapshots/ # insta snapshots for Tier-2 tests
|
||||
│ ├── theme.rs type_change.rs ui.rs undo.rs # themes / column type-change / render / undo ring
|
||||
│ └── lib.rs # module re-exports for tests
|
||||
├── tests/
|
||||
│ ├── it/ # Tier-3 integration tests (consolidated into one binary)
|
||||
│ └── typing_surface_matrix.rs # typing-surface matrix (separate Tier-3 target)
|
||||
└── website/ # Astro + Starlight docs/marketing site (ADR-website-001)
|
||||
├── src/ public/ casts-src/ # pages + assets + asciinema cast sources
|
||||
└── astro.config.mjs package.json … # deploys to Cloudflare Pages via Gitea Actions
|
||||
```
|
||||
|
||||
Key invariants in the code:
|
||||
|
||||
Reference in New Issue
Block a user