Skip to content

docs(release): align the docs with marfa v0.0.26 - #587

Merged
aicayzer merged 3 commits into
mainfrom
docs/sync-marfa-v0.0.26
Oct 22, 2026
Merged

aicayzer merged 3 commits into
mainfrom
docs/sync-marfa-v0.0.26

Conversation

@aicayzer

Copy link
Copy Markdown
Contributor

Summary

Syncs the docs with Marfa v0.0.26 (tag v0.0.26, commit 6e66d6e2b). The release changes the database's shape and replaces how the owner's picture works: it is now an uploaded file, and a web address is no longer accepted. This pull request moves the generated files to 0.0.26 and brings every page about the owner's profile and picture, the Upgrade guide and the install guide in line with it.

Changes

  • Synced from the v0.0.26 tag only: openapi.json, cli-commands.json, contract-index.json, marfa-release.json, cli-download.md and server-image.md.
  • changelog.mdx: v0.0.26 entry. It says plainly that the release changes the database's shape, that a v0.0.25 database is refused unchanged and nothing is migrated, and it points at the Upgrade guide.
  • sign-in-as-the-owner.mdx: "Change the owner's profile" rewritten for an uploaded picture (PNG, JPEG or WebP, 2 MiB or less, 1 to 4096 pixels), with the console steps, the socket commands and the refusals. The "Confirm it's you" bullet names the picture.
  • permissions.mdx, access.mdx and cli.mdx: the avatar permission, the profile map and the owner update and owner picture commands say "picture", and no longer describe a web address.
  • upgrade.mdx and export-and-restore.mdx: the archive carries no owner's picture, so the upgrade steps upload it again.
  • install.mdx: the sample output and the text under "Choose how it's reached" match the new marfa server install (where a tunnel or proxy must point, the host beside the folder, the closing hint for AI agents).
  • devices.mdx and troubleshooting.mdx: the new replaceRefused call, which sets a refused working copy aside and opens an empty one.

Testing

  • pnpm test: 588 tests pass in 37 files, including the content lint, link checks and the CLI command check.
  • pnpm build, pnpm build:status and pnpm types:check pass.
  • sync-from-marfa.test.sh: 615 passed.
  • In a marfa checkout at the tag, the server's owner-picture route and schema tests pass (35 tests).
  • Not tested: no server or CLI was run against the new examples; the sample install output and the picture limits were read from the code and tests at the tag.

Notes for reviewers

  • The sync read a checkout at the tag. No commit has landed on marfa main since the tag.
  • The staleness report was run between the v0.0.25 and v0.0.26 syncs, and each page it lists was read against the contract and the code. The createKey and createOwner entries only change schema descriptions, so they needed no page edit.
  • The owner profile and picture pages were read in context, not edited line by line: the sign-in guide, the permissions catalog, the access overview, the CLI page and the changelog agree with each other.
  • The v0.0.21 changelog line "Profile accepts a picture address" is history and stays as written.
  • Review depth: a reviewer is warranted, because the docs say publicly what Marfa does with the owner's data. Please check against the code: the picture limits and the 400/413 answers; who may call PUT /owner/picture, PUT /profile/picture and GET /owner/picture; that an update takes avatar only as null; the auth_user.image to owner_picture change and the exit 78 refusal; that the archive carries no picture; the marfa server install text; and the replaceRefused wording.

Checklist

  • The title is a scoped Conventional Commit.
  • No test was needed: prose and synced files only.
  • Docs, comments and the contract still say what is true after this change.

@aicayzer
aicayzer marked this pull request as ready for review October 22, 2026 18:36
@aicayzer
aicayzer merged commit 883722b into main Oct 22, 2026
8 checks passed
@aicayzer
aicayzer deleted the docs/sync-marfa-v0.0.26 branch October 22, 2026 18:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant