Skip to content

docs: a true "5 minutes to Hello World" for x.klickd getting-started#113

Merged
Davincc77 merged 1 commit into
mainfrom
docs/getting-started-5min-hello-world
Jun 1, 2026
Merged

docs: a true "5 minutes to Hello World" for x.klickd getting-started#113
Davincc77 merged 1 commit into
mainfrom
docs/getting-started-5min-hello-world

Conversation

@Davincc77
Copy link
Copy Markdown
Owner

Summary

Docs-only. Rewrites docs/getting-started.md as a tighter, more direct "5 minutes to Hello World" for x.klickd, aimed at reducing time-to-first-success.

  • Clear promise up top: load one x.klickd starter skill, turn it into model context, see the output — no account, no server, no API key.
  • Front-loads a verified dry-run path (Python + TypeScript) with the exact expected output, before any caveats. No LLM call required for the smoke test.
  • Integrations table moved after the quick path, not before, with the richer comparison linked afterward.
  • Encrypted-envelope details, load_klickd/loadKlickd, and the dual loader demoted to Next so they don't block the first success. "Compressed memory is optional" noted there.
  • Net shorter: ~443 → ~412 words.

Guardrails preserved

  • No automatic GDPR / EU AI Act compliance claim (claim boundary kept verbatim).
  • No universal-standard / universal-native-support wording.
  • No benchmark or performance claims.
  • Compressed memory explicitly optional.

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

  • Dry-run verified locally (installed packages/pypi/klickd, ran the Python snippet): output is exactly x.klickd/coding / False, matching the doc.
  • Package/API names verified against repo: klickd (PyPI), @klickd/core (npm), get_starter_skill_bytes / getStarterSkillBytes, and the x_klickd_pack.pack / encrypted fields all confirmed in source.
  • All 15 relative links resolve to real files.
  • markdownlint (default ruleset, repo has no config): 20 hits vs 23 on the original — net improvement, no new rule categories; remaining hits are line-length/table-style defaults the repo does not enforce.

Testing

  • pip install -e packages/pypi/klickd + run Python snippet -> expected output
  • Link existence check (15/15)
  • Guardrail grep (claim boundary present; forbidden phrasing absent)
  • Maintainer review

Docs-only; please do not merge without Vince's review.

🤖 Generated with Claude Code

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>
@Davincc77 Davincc77 merged commit 3a1762b into main Jun 1, 2026
3 checks passed
@Davincc77 Davincc77 deleted the docs/getting-started-5min-hello-world branch June 1, 2026 08:35
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