Skip to content

docs(catalog): describe Readwise highlight titles and field kinds - #690

Merged
aicayzer merged 5 commits into
mainfrom
docs/readwise-display
Oct 29, 2026
Merged

aicayzer merged 5 commits into
mainfrom
docs/readwise-display

Conversation

@aicayzer

@aicayzer aicayzer commented Oct 29, 2026 •

Copy link
Copy Markdown
Contributor

Summary

The Readwise and Readwise Reader catalog pages now describe the highlight title and body fields, the date, time and address field kinds, original_values, and the schema step an existing install needs. This matches withmarfa/marfa-connectors#308, which should merge first, because these pages link to the README section it adds.

Changes

  • Readwise: under Types it writes, a paragraph on title and body (the title is the passage's first paragraph, where a blank line ends one and a heading is one of its own, without leading list or quotation markers, a permalink mark or a gap before closing punctuation) and one on field kinds and original_values. Under What to know, the upgrade step and what the first run does.
  • Readwise Reader: how the highlight body and title are chosen (the title from the export passage, or Reader's when the export has no words, ended by a heading in either), title and body listed as read only under What goes back, and a link to the upgrade section from the schema bullet.

Testing

Notes for reviewers

A light review is enough: two catalog pages, with every fact taken from the connector change.

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 marked this pull request as ready for review October 29, 2026 15:02
@aicayzer

Copy link
Copy Markdown
Contributor Author

Review depth: reviewed with withmarfa/marfa-connectors#308 over two rounds.

@aicayzer
aicayzer merged commit 4f3c075 into main Oct 29, 2026
3 checks passed
@aicayzer
aicayzer deleted the docs/readwise-display branch October 29, 2026 15:34
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