Skip to content

Improve docs 2 - #36

Merged
inoas merged 6 commits into
mainfrom
improve-docs-2
Jun 6, 2026
Merged

Improve docs 2#36
inoas merged 6 commits into
mainfrom
improve-docs-2

Conversation

@inoas

@inoas inoas commented Jun 6, 2026

Copy link
Copy Markdown
Owner

No description provided.

Copilot AI review requested due to automatic review settings June 6, 2026 08:30

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Pull request overview

This PR focuses on improving Cake’s documentation by clarifying XOR semantics across adapters, refreshing README links, and adding a new Markdown-based API reference under docs/api/.

Changes:

  • Clarifies xor_where documentation to state that Cake always emulates “exactly-one” XOR via OR/AND/NOT, and points users to where.xor_parity for MariaDB/MySQL parity XOR.
  • Updates README HexDocs links and removes the large “Library Design” diagram section from the README.
  • Adds a new API reference documentation set under docs/api/* and registers a new “DIAGRAMS” documentation page in gleam.toml.

Reviewed changes

Copilot reviewed 14 out of 14 changed files in this pull request and generated 3 comments.

Show a summary per file
File Description
src/cake/update.gleam Updates xor_where doc comment to clarify adapter behavior and direct users to xor_parity where appropriate.
src/cake/select.gleam Updates xor_where doc comment with the same clarified XOR-emulation guidance.
src/cake/delete.gleam Updates xor_where doc comment with the same clarified XOR-emulation guidance.
README.md Updates HexDocs URL and removes the in-README “Library Design” diagram section.
gleam.toml Adds a “DIAGRAMS” docs page entry (currently pointing at docs/diagrams.md).
docs/api.md Adds a top-level API docs placeholder page.
docs/api/index.md Adds an API reference landing page and module index.
docs/api/select.md Adds Markdown API reference for cake/select.
docs/api/insert.md Adds Markdown API reference for cake/insert.
docs/api/update.md Adds Markdown API reference for cake/update.
docs/api/delete.md Adds Markdown API reference for cake/delete.
docs/api/where.md Adds Markdown API reference for cake/where, including xor vs xor_parity explanation.
docs/api/join.md Adds Markdown API reference for cake/join (includes some exclusive-join wording issues).
docs/api/fragment.md Adds Markdown API reference for cake/fragment, including safety guidance.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread gleam.toml
Comment thread docs/api/join.md Outdated
Comment thread docs/api/join.md Outdated
@inoas
inoas force-pushed the improve-docs-2 branch from 8ab3587 to a6b4989 Compare June 6, 2026 09:35
@inoas
inoas force-pushed the improve-docs-2 branch from a6b4989 to c5d6caa Compare June 6, 2026 11:25
@inoas
inoas merged commit 425fc40 into main Jun 6, 2026
6 checks passed
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.

2 participants