You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
This commit was created on GitHub.com and signed with GitHub’s verified signature.
feat(docs): docs refresh (#186)
Title, fix docs and add an init command.
<!-- Macroscope's pull request summary starts here -->
<!-- Macroscope will only edit the content between these invisible
markers, and the markers themselves will not be visible in the GitHub
rendered markdown. -->
<!-- If you delete either of the start / end markers from your PR's
description, Macroscope will append its summary at the bottom of the
description. -->
> [!NOTE]
> ### Refresh puffgres docs and add interactive scaffold confirmation to
`puffgres init`
> - Reorganizes docs with new sections: *Why puffgres?*, *Programming
model*, *Getting started*, *Deployment model*, *Advanced options*, and
*Command reference*, replacing prior structure.
> - Adds new content explaining the programming model (configs, schema
generation, JSONL transforms, tombstoning, batching, DLQ) and deployment
flow (state persistence, CI checks, OTEL observability).
> - Updates
[`advanced-options.md`](https://github.com/a24films/puffgres/pull/186/files#diff-023356fd90b5614c9f39caf33ec4dcefebfcce01f411ac5cfb76321162e8edd4)
(renamed from `configuration.md`) and
[`command-reference.md`](https://github.com/a24films/puffgres/pull/186/files#diff-e52b776fb88dea7b1c9d3e3925ce65e080c8580bbe99e8be0e7df573d8d20524)
with clearer descriptions and cautionary notes.
> - Adds an interactive confirmation prompt in
[`init.rs`](https://github.com/a24films/puffgres/pull/186/files#diff-f96f7e38336513078799d51a8c3326a2a124a0a829a82f5dd138e30efe166f23)
that previews the scaffold structure and asks for user consent before
creating any files on a fresh project.
>
> <!-- Macroscope's review summary starts here -->
>
> <sup><a href="https://app.macroscope.com">Macroscope</a> summarized
2bcb29c.</sup>
> <!-- Macroscope's review summary ends here -->
>
<!-- Macroscope's pull request summary ends here -->