docs: correct project status and documentation drift - #98
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
A documentation accuracy pass over the whole repo, plus the record of the two deferred Wave D
components. No behaviour changes — Go edits here are comments only.
Stale project status
README.md,docs/index.md,ROADMAP.md, anddocs/roadmap.mdall still said Phase 3 was"next" despite every planned component being merged. They now say the planned components are
merged and unreleased, with further work expected before v0.3 — deliberately not "complete",
since more is planned before release.
docs/roadmap.mdhad drifted fromROADMAP.mdIt was missing four Phase 2 bullets (chunk bounds, auto-retry/failure limits, cross-job
dependencies, testing presets) and the retry-policy four-tier clause. It is a pure copy modulo
link paths, so it was regenerated and byte-verified against
ROADMAP.mdunder path substitution.README had no path to enabling auth
The feature was advertised but
auth.enabledanddocs/auth.mdappeared nowhere in README,docs/index.md, or the quickstart. Added a pointer in the feature bullet and in the deploymentsection, where "there is no authentication in this mode" is the load-bearing fact.
docs/configuration.md— one materially wrong statementIt described the LDAP and OIDC blocks as "inert" without
auth.enabled. They are not: thatcombination fails validation and the server refuses to start. The doc now shows the actual
error text, so nobody stages an LDAP block behind a closed auth gate and wonders why the server
is down. Also documented two previously unstated rules:
auth.session.cookie_namemust benon-empty when auth is on (an empty name silently disables CSRF), and
discovery.instance_namemust be non-empty regardless of
discovery.enabled.Every other key, default, env var, and CLI flag was audited against
internal/configand matched.docs/architecture.md— the auth subsystem was absentNo
internal/authrow, no boot step, nousers/sessions/api_keystables. All added. Twopre-existing errors fixed while there: the chi router was attributed to
internal/serverwhen itlives in
internal/api(contradictingdocs/development.md), and the schema table was alsomissing
job_dependencies,task_logs, andproductsfrom Phase 2.Wave D deferrals recorded
D1 (per-user concurrent task caps) is deferred with no driver behind it; D2 (custom limit
dimensions) is dropped as already delivered by Phase 1 count-based usage pools. Both ROADMAP
bullets are struck.
This required re-justifying merged code:
auth.validate_job_ownerand the canonical-casingstorage in
bindSubmitIdentitywere documented as existing for per-user caps. They now citeowner-scoped visibility — a typo'd or miscased owner yields a job invisible to its real owner
under the
userrole's owner-filtered listings — which is true today and does not lean on anunbuilt feature. Behaviour unchanged; only the stated reason moved.
Also
docs/development.mdwas missingtest-ldap,test-oidc, andsmokefrom its Makefile targettable.