lucas/logview

Watch

Fork 0

generated from lucas/rust-webserver-template

docs: split the documentation by role and rewrite STATUS #47

Open

omp-deck wants to merge 1 commit from agent/issue-46-docs-role-split into master

omp-deck commented

2026-11-14 10:58:41 +01:00

Collaborator

Documentation only — nothing under src/, templates/, tests/ or assets/ is touched.

The four documentation files did not hold to distinct roles, so the same material was written down twice and the copies drifted; docs/STATUS.md had drifted furthest, still describing the tree as an empty scaffold.

docs/DESIGN.md gains two unnumbered sections ahead of ## 1. Purpose: ## Architecture (view abstraction, dependency direction, request flows) and ## Invariants (the six invariants, each now naming the decision it derives from). The decision numbers are untouched, so nothing citing a §number breaks. The intro and §11 no longer point at AGENTS.md for the derived rules.
AGENTS.md loses ## Architecture & Data Flow, ## Key Directories and ## Development Commands, and the design prose in its overview, error policy and tooling sections is replaced by links to the corresponding DESIGN.md decisions. The operative rules (error policy, secret handling, crate::assets::url, conventions, testing) stay.
docs/development.md absorbs the three command notes it did not already carry — the cargo-watch scoping rationale, docker build -t logview ., and the CI job graph — and its docs/ layout row is corrected.
docs/STATUS.md is rewritten as a list of deviations from the design, one entry per gap, naming the section it deviates from. No file paths, no symbol inventory: the inventory is what rotted, because it had to be revised on every change rather than only when a gap closes.
README.md's documentation list is corrected and gains the missing docs/development.md bullet.

Every gap claimed in the new STATUS.md was checked against the tree: no tail path or row SSE route (src/dev_reload.rs is the only SSE), no time-range handling in src/views/ or src/routes/, no view trait or mode enum, no sort_direction, no rust-toolchain.toml.

cargo test is green (12 view tests, 7 victorialogs, plus the rest); the suite is run only to confirm no source or template file was touched by accident.

Closes: #46

Documentation only — nothing under `src/`, `templates/`, `tests/` or `assets/` is touched. The four documentation files did not hold to distinct roles, so the same material was written down twice and the copies drifted; `docs/STATUS.md` had drifted furthest, still describing the tree as an empty scaffold. - **`docs/DESIGN.md`** gains two unnumbered sections ahead of `## 1. Purpose`: `## Architecture` (view abstraction, dependency direction, request flows) and `## Invariants` (the six invariants, each now naming the decision it derives from). The decision numbers are untouched, so nothing citing a §number breaks. The intro and §11 no longer point at `AGENTS.md` for the derived rules. - **`AGENTS.md`** loses `## Architecture & Data Flow`, `## Key Directories` and `## Development Commands`, and the design prose in its overview, error policy and tooling sections is replaced by links to the corresponding `DESIGN.md` decisions. The operative rules (error policy, secret handling, `crate::assets::url`, conventions, testing) stay. - **`docs/development.md`** absorbs the three command notes it did not already carry — the `cargo-watch` scoping rationale, `docker build -t logview .`, and the CI job graph — and its `docs/` layout row is corrected. - **`docs/STATUS.md`** is rewritten as a list of deviations from the design, one entry per gap, naming the section it deviates from. No file paths, no symbol inventory: the inventory is what rotted, because it had to be revised on every change rather than only when a gap closes. - **`README.md`**'s documentation list is corrected and gains the missing `docs/development.md` bullet. Every gap claimed in the new `STATUS.md` was checked against the tree: no tail path or row SSE route (`src/dev_reload.rs` is the only SSE), no time-range handling in `src/views/` or `src/routes/`, no view trait or mode enum, no `sort_direction`, no `rust-toolchain.toml`. `cargo test` is green (12 view tests, 7 victorialogs, plus the rest); the suite is run only to confirm no source or template file was touched by accident. Closes: #46

omp-deck added 1 commit

2026-11-14 10:58:41 +01:00

docs: split the documentation by role and rewrite STATUS

pr / lint (pull_request) Successful in 28s

Details

pr / assets (pull_request) Successful in 29s

Details

pr / check (pull_request) Successful in 51s

Details

pr / test (pull_request) Successful in 59s

Details

pr / image (pull_request) Successful in 6m34s

Details

b980eaee53

The four documentation files did not hold to distinct roles, so the same
material was written down more than once and the copies drifted.
STATUS.md was the worst case: it still described the repository as an
empty scaffold with no VictoriaLogs integration, no views and no
wiremock, all of which have existed for some time.

The division is now: DESIGN.md carries the full design, AGENTS.md how an
agent works here, STATUS.md only what differs from the design, and
development.md setup, commands, layout and conventions for humans.

The architecture overview and the six invariants move from AGENTS.md
into DESIGN.md as two unnumbered sections ahead of the decisions, so the
existing decision numbers stay stable and nothing citing a section
number breaks; each invariant now names the decision it derives from.
AGENTS.md loses its design prose, its duplicate directory table and its
duplicate command list, keeping links where the rationale moved; the
three command notes development.md lacked (cargo-watch scoping, the
release-image build, the CI job graph) move there.

STATUS.md is rewritten as a list of deviations from the design, with no
inventory of what exists: an inventory is what rotted, since it has to
be revised on every change rather than only when a gap closes.

Closes: #46
Co-Authored-By: Claude Opus 5 via omp-deck

pr / lint (pull_request) Successful in 28s

Required

Details

pr / assets (pull_request) Successful in 29s

Required

Details

pr / check (pull_request) Successful in 51s

Required

Details

pr / test (pull_request) Successful in 59s

Required

Details

pr / image (pull_request) Successful in 6m34s

Required

Details

This pull request can be merged automatically.

You are not authorized to merge this pull request.

View command line instructions

Checkout

From your project repository, check out a new branch and test the changes.

git fetch -u origin 'agent/issue-46-docs-role-split:agent/issue-46-docs-role-split'

git switch 'agent/issue-46-docs-role-split'

No reviewers

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

lucas/logview!47

No description provided.

Rows
Columns