Skip to content

docs(release): align the docs with marfa v0.0.15 - #515

Merged
aicayzer merged 4 commits into
mainfrom
docs/090-v0.0.15
Oct 19, 2026
Merged

aicayzer merged 4 commits into
mainfrom
docs/090-v0.0.15

Conversation

@aicayzer

Copy link
Copy Markdown
Contributor

Summary

Aligns the docs with marfa v0.0.15: the release sync, a v0.0.15 changelog entry, and the guide and reference changes the release's pull requests call for.

Changes

  • Sync. scripts/sync-from-marfa.sh against a clean checkout of the v0.0.15 tag: release data, CLI download, server image snippet, settings, error codes (compatible_with_violation now names details.dependent_type_ids) and openapi.json.
  • Changelog. A v0.0.15 entry in the shape of v0.0.14, dated October 19, 2026 (the tag's date). Each line was checked against the contract and code at the tag.
  • Types. The define-a-type guide and the type rules page now say that replacing or deleting a type that another type depends on through compatible_with can be refused with details.dependent_type_ids, that force=true does not bypass it, and that adding a parent or compatibility target needs write permission on it while keeping one does not.
  • Back up and restore. Says an edge to an item in the bin is restored, and names the reasons edges_skipped_reasons can carry. The guide did not list item_not_found.

Testing

  • pnpm test: 28 files, 354 tests passed.
  • pnpm build: passed; checked the changelog, define-a-type and back-up pages in dist/.
  • Both through Tools/heavy-run/heavy-run.
  • CI not awaited.

Notes for reviewers

  • A replacement is refused only when it breaks a dependent's claim, not whenever a dependent exists (types/compatible-with-preserved). A deletion is always refused while dependents exist. The docs say so.
  • The pull request bodies for #2181, #2182, #2183 and #2142 have no "Docs pass" line. Their changes are covered from the contract at the tag.
  • Left out of the changelog as internal: #2131, #2135, #2137, #2139, #2140, #2177, #2184, and the refusal to remove a retired platform type with dependents (409 conflict).

Checklist

  • Checked against marfa at v0.0.15
  • No em dashes, American English
  • Generated files changed only by the sync
  • Review

@aicayzer aicayzer left a comment

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Review: ready to merge

Summary. Brings the docs in line with v0.0.15: the synced release data and references, a v0.0.15 changelog entry, the type rules for replacing or deleting a type others depend on, and the restore's edge skip reasons. Safe to merge.

First draft: 4/5. Two untrue sentences found and fixed.

Checked.

  • True: each changelog line against its pull request, and the type and restore pages against the contract and code at tag v0.0.15.
  • Generated data: a sync from the tag produces no diff in src/generated/ or openapi.json.

Found.

  • The compatible_with example used a platform type, which can be neither replaced nor deleted, so the 422 it described cannot happen. Reworded in 122d155.
  • The changelog said a bulk job "finishes" when its key is revoked; it ends failed and writes nothing more. Fixed in 122d155.

Quick fixes. 2 applied by the reviewer.


Reviewed by withmarfa-reviewer on claude-sonnet-5-5. This review may contain mistakes.

@aicayzer
aicayzer marked this pull request as ready for review October 19, 2026 11:49
@aicayzer
aicayzer enabled auto-merge (squash) October 19, 2026 11:49
@aicayzer
aicayzer merged commit 9be4add into main Oct 19, 2026
8 checks passed
@aicayzer
aicayzer deleted the docs/090-v0.0.15 branch October 19, 2026 11:53
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