Skip to content

docs(content): apply the final read's fixes - #764

Merged
aicayzer merged 4 commits into
mainfrom
docs/final-read
Nov 1, 2026
Merged

aicayzer merged 4 commits into
mainfrom
docs/final-read

Conversation

@aicayzer

@aicayzer aicayzer commented Nov 1, 2026 •

Copy link
Copy Markdown
Contributor

Summary

The fixes from the final read of session 157's docs pass. The site now says items and edges, not rows and connections, and the bin, not the trash. Several passages written in an engineer's voice read plainly. The folder setup for Mac apps moves into the Swift SDK reference. The agent copies lose their table padding and list pages in sidebar order.

Changes

  • Items, edges and the bin. The connector pages (Todoist, GitHub, Readwise, Readwise Reader, RSS, Google Calendar and the Connectors landing page), Export and restore and the Google connectors troubleshooting page say "item" for what Marfa stores and "edge" for a link between items. Every page says "the bin" and "move to the bin". trash stays only in literal names: the owner's Trash page, trashed, trash-purge, TRASH_RETENTION_DAYS and API operation titles. STYLE.md gains a vocabulary line for this.
  • Read a view. The app section covers only the Swift SDK. The Rust core and the Node binding are internal, not something an app calls. The table's signatures match Sources/Marfa/Views.swift in marfa-swift.
  • Plainer passages. Housekeeping (the owner empties the bin, and the clock-moving section becomes one sentence linking the contract's test hooks), Settings, Keep folders running, Change a type, Sign in as the owner and Run a connector.
  • Mac folder setup. "Use a folder from a Mac app" was mostly one Swift sample. It becomes the "Set up a folder" section of the Swift SDK's Views and folders page, and Sync a folder and Folder safeguards link there.
  • Landing and owner pages. Run gains a Run a connector card. The Home table on Sign in as the owner links Connectors and Folders to their pages.
  • Overview. The two sentences on Files and on Items and types, as the read worded them. The second-copy wording follows the contract's stores chapter.
  • Agent surfaces.
    • The Markdown copies, and so llms-full.txt, write tables without column padding. llms-full.txt is about a fifth smaller, and the tables are still valid GFM.
    • llms-full.txt lists pages in sidebar order, as llms.txt promises. A new test checks the order.
    • docs-map.md opens with the sentence the read gave. The docs_fetch tool describes what it returns and the path forms it accepts.
    • The /docs/ path alias is gone. marfa docs strips that prefix before it calls the site, marfa-plugin never sends it, and nothing else on the site used it.
  • STYLE.md. The "Less is clearer" sentence on pending ceilings is rewritten.
  • Folder safeguards is trimmed back within its 1,500-word limit, which docs(run): say a folder added again takes back its files #763 and the bin wording took it over. "Bin its item elsewhere" becomes "move the item to the bin elsewhere". Items and types no longer says "binned".

Testing

  • pnpm test passes (829 tests), including the word limits, the content lint, the CLI command check and the MCP and .md tests.
  • pnpm build passes. In vite preview, a crawl of every page in docs-map.md found no broken internal link or section link (116 pages).
  • I checked the changed pages at desktop width and at 375 px with device emulation: no horizontal scroll, and the Home table stacks. I also read their .md copies.

Notes for reviewers

  • The Sign in as the owner page keeps "Connections" because it is the owner page's literal group name.
  • The Swift SDK pages keep "rows" where they mean the Rows type. Upgrade keeps "rows" where it means database rows. The connector pages keep "row" and "connection" where they mean a table row, "in a row" or a network connection.
  • The google-calendar README in marfa-connectors still says "row". It is not a docs page, so this pull request leaves it.

Checklist

  • The title is a scoped Conventional Commit.
  • New behavior has a test that was seen failing first, or no test was needed and the reason is above.
  • Docs, comments and the contract still say what is true after this change.

@aicayzer
aicayzer merged commit eb943fe into main Nov 1, 2026
8 checks passed
@aicayzer
aicayzer deleted the docs/final-read branch November 1, 2026 01:21
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