docs: add getting-started guide; refresh curiosity guide + README hero - #35
Merged
Conversation
Add docs/getting-started.md — a one-binary quickstart with a "let your agent install it" box, manual install steps, a first-durable-state walkthrough, and links onward. The docs site's navigation references getting-started.md, so it must exist on primkit@main for the site build (docs:sync) to pass. Also shorten the curiosity guide H1 to "Building Curious Agents", normalize "PrimKit" -> "primkit", and refresh the README hero. Assisted-By: Claude Opus 4.8
CI installs `gofumpt@latest` (now v0.10.0); main was last formatted with an older version, so the Format check reformats 16 files on every PR. This is the output of `make fmt` — pure formatting, no behavior change — which is what the Format check requires to pass. Assisted-By: Claude Opus 4.8
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds the missing
docs/getting-started.md(referenced by the primkit-site nav, so required for the site build), shortens the curiosity guide H1, normalizes PrimKit→primkit, and refreshes the README hero. Docs-only.