Skip to content

Move the docs into docs/ and keep them out of the dist - #8

Merged
adrorocker merged 1 commit into
masterfrom
docs
Aug 24, 2026
Merged

Move the docs into docs/ and keep them out of the dist#8
adrorocker merged 1 commit into
masterfrom
docs

Conversation

@adrorocker

Copy link
Copy Markdown
Owner

The readme had grown to 599 lines, which is too long to be a landing page and
too short to be a manual. Split it up.

README keeps the intro, what the package is and is not, installation, one
example and the history. Everything else moves to docs/:

  • getting started - entities, repositories, connecting
  • reading and writing - saving, batches, transactions, server values
  • queries and modelling - the query builder, and what each backend can run
  • errors - what gets thrown and what it carries
  • extending it - other backends, other constraints, your own query methods
  • upgrading from 0.x (moved from UPGRADING.md, history preserved)

docs/ is export-ignored, so composer require now pulls down only:

LICENSE  README.md  composer.json  src/

README stays at the root on purpose - Packagist and GitHub read it for the
project page.

Every relative link in the readme and the six pages was checked to make sure it
still resolves. No code changed; 165 tests still pass.

@adrorocker
adrorocker merged commit 785b757 into master Aug 24, 2026
5 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.

1 participant