Skip to content

docs: AI-first quickstart + Playground card on landing#6

Merged
Agilulfo1820 merged 1 commit into
mainfrom
dan/ai-first-readme
May 21, 2026
Merged

docs: AI-first quickstart + Playground card on landing#6
Agilulfo1820 merged 1 commit into
mainfrom
dan/ai-first-readme

Conversation

@Agilulfo1820

Copy link
Copy Markdown
Member

Summary

Mirror the AI-first treatment from vechain/vechain-kit#628 (playground) and #629 (homepage + npm README) on GitBook.

Landing (README.md)

Quickstart (`docs/quickstart/installation.md`)

  • Same two prompts surfaced at the top of the page (before the existing `create-vechain-dapp` CLI section).
  • Fixes a trailing-junk typo on the install command (`framer-motion@^11.15.0Install peer dependencies` → `framer-motion@^11.15.0`).

Why

The Kit ships with a VeKit Playground where every demo is paired with a ready-made AI prompt. The npm README, the repo README and the playground itself all open with these prompts now — the docs landing is the last surface where new devs land that didn't have them yet.

Test plan

  • GitBook preview renders the `{% tabs %}` and `{% code %}` blocks correctly.
  • The new "VeKit Playground" card appears at the top of the landing cards.
  • Pasting either prompt into Claude Code / Cursor triggers the expected agent behaviour (reads the skill, then scaffolds / wires the kit).

🤖 Generated with Claude Code

Add a "Start with AI" section to the landing README and to
quickstart/installation.md with two copyable prompts (start-from-scratch
via create-vechain-dapp, add-to-existing-project) that instruct the
agent to read the relevant VeChain AI Skill from
github.com/vechain/vechain-ai-skills before doing anything else.

Add a "VeKit Playground" card to the landing cards table so the live
playground at playground.vechainkit.vechain.org is one click away.

Also fix the trailing junk text on the install command in installation.md
(`framer-motion@^11.15.0Install peer dependencies` → `framer-motion@^11.15.0`).

Co-Authored-By: Claude Opus 4.7 (1M context) <[email protected]>
@Agilulfo1820 Agilulfo1820 merged commit b3ddbb5 into main May 21, 2026
2 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