docs: a true "5 minutes to Hello World" for x.klickd getting-started#113
Merged
Conversation
Lead with a concrete promise (load one starter skill, turn it into model context, see the output), front-load a verified dry-run path with expected output, and move the integrations table after the quick path. Guardrails preserved verbatim. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
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
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.
Summary
Docs-only. Rewrites
docs/getting-started.mdas a tighter, more direct "5 minutes to Hello World" for x.klickd, aimed at reducing time-to-first-success.load_klickd/loadKlickd, and the dual loader demoted to Next so they don't block the first success. "Compressed memory is optional" noted there.Guardrails preserved
Why README is barely touched
The README quickstart already links to this page in a single line and is not over-expanded, so no README change was needed (requirement 7 — adjust only if it now duplicates too much). Left as-is.
Checks
packages/pypi/klickd, ran the Python snippet): output is exactlyx.klickd/coding/False, matching the doc.klickd(PyPI),@klickd/core(npm),get_starter_skill_bytes/getStarterSkillBytes, and thex_klickd_pack.pack/encryptedfields all confirmed in source.Testing
pip install -e packages/pypi/klickd+ run Python snippet -> expected outputDocs-only; please do not merge without Vince's review.
🤖 Generated with Claude Code