docs(feat): add "Use your first block" walkthrough#151
Open
Ducksss wants to merge 1 commit into
Open
Conversation
A Get Started page bridging install → admin → live: shows the block already in the Payload admin picker after `add`, with captured admin screenshots (picker + fields) and the live component preview. Also prints a post-install "next steps" hint in the CLI pointing to the admin and the walkthrough. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Owner
Author
|
Current action: keep open on |
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.
What
A Get Started walkthrough — "Use your first block" — bridging what
payload-components adddoes to your files and what an editor actually does in the Payload admin. The gap it fills: nothing previously showed the payoff that afteradd, the block is already in the admin block picker, wired and ready.content/docs/first-block.mdx— install → admin → live, using Feature Grid Basic: a "why it's already wired" callout, 5 steps (admin → Add Block → fill → publish → live), real admin screenshots for the picker + fields, and the live<ComponentPreview>for the result.content/docs/meta.json— slotted into Get Started, right after Installation.tools/payload-components/commands/add.ts— post-install "next steps" hint pointing to the admin and the walkthrough (block name derived from the manifest'spagesLayoutfragment).public/docs/admin/*.png— captured from a real Payload admin.Verification
fumadocs-site,payload-components-add-command)./llms.txt,/llms-full.txt, per-page markdown, structured data) — new page is additive, contract intact./docs/first-block: renders with both screenshots, the live component preview, and the sidebar entry after Installation; no console errors.🤖 Generated with Claude Code