Repository navigation
docs(release): align the docs with marfa v0.0.19 - #526
Merged
Merged
Conversation
aicayzer
commented
Oct 21, 2026
aicayzer
left a comment
Contributor
Author
There was a problem hiding this comment.
Review: ready to merge
Summary. The pull request aligns the docs with Marfa v0.0.19, and every new statement was checked against the v0.0.19 contract, API description, CLI reference and server code; the faults found were over-broad wording, fixed in this branch.
First draft: 4/5. Two statements were untrue as written (a five-minute sign-in claimed for viewing pages, and a secret claimed hidden on "every page"), plus ambiguous or over-restated wording; none blocking, all fixed in 1db3637.
Checked.
- True: page addresses and what each console page does (General, Health, Connected apps, Browsers, Activity, All settings, Export and restore, Connectors) against the route and page code; the eight newly secret settings and the
MARFA_AUTH_BASE_URLrefusal;PATCH /configsemantics, refusals and audit action; thekindandqaudit filters;files=false; thatmarfa auditandmarfa exporttake none of the new options. - True: every contract anchor and guide anchor the new text links exists; no page in
content/orsrc/still sends the owner to/auth/owner/manageor/auth/owner/restoreor says an export always includes files;openapi.jsonis byte-identical to marfa's. - Done:
pnpm test(354 tests),pnpm build,pnpm build:statusandpnpm types:checkpass.
Found.
- Sign-in rule overstated. The Changelog said both new pages need a sign-in within five minutes; only disconnecting an app and signing out another browser do. Fixed in 1db3637.
True - Secrets hidden "on every page". The contract promises it for the All settings pages and Home; reworded. Fixed in 1db3637.
True - Old addresses "do not redirect". A signed-out browser is sent to sign in, as for any owner path; reworded to say nothing redirects to the new pages. Fixed in 1db3637.
True - Ambiguous and misplaced sentences. The General sentence sat inside the fields-table lead-in, the Activity sentence broke the lead-in to an example, and the Home table promised addresses it did not give. Fixed in 1db3637.
True - Contract rules restated. The
files=falsemanifest rule and thePATCH /configrefusal list were trimmed to a plain statement that links the rule. Fixed in 1db3637.True
Quick fixes. 7 applied by the reviewer.
Reviewed by withmarfa-reviewer on Sonnet. This review may contain mistakes.
aicayzer
marked this pull request as ready for review
October 21, 2026 01:55
aicayzer
enabled auto-merge (squash)
October 21, 2026 01:55
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.
Summary
Aligns the docs with Marfa v0.0.19: syncs the generated reference, adds the Changelog entry for what the owner console,
PATCH /config, the audit filters and file-free exports change for a person, and fixes the pages this release makes untrue.Changes
scripts/sync-from-marfa.sh):openapi.json, the contract index, the settings table, the release and its install commands.files=false.PATCH /configandmarfa config update, the General and All settings pages, and what makes a setting a secret.kindandqfilters and the Activity page.Testing
pnpm test(354 tests, including the content lint),pnpm build,pnpm build:statusandpnpm types:checkpass.content/andsrc/for/auth/owner/manage,/auth/owner/restore, "Manage" and "management" and found the two pages fixed here.openapi.json,COMMANDS.mdand the server code for the pages.Notes for reviewers
marfa audittakes neitherkindnorq, andmarfa exporthas no option forfiles=false; the pages say so.Checklist