Docs redesign — week 3 persona quickstarts#631
Closed
kiryl-xyz wants to merge 2 commits into
Closed
Conversation
5 persona quickstarts under /quickstart/ matching PRD §WS-4. Each is <5 minutes from sign-up to working call, with a copy-pasteable Node project mirrored to examples/quickstarts/<persona>/ for StackBlitz embedding. Quickstarts (each follows the PRD's 7-section template: Outcome, Prerequisites, Install, Run-it, Expected output, Troubleshooting, Next steps with 3 cards) | Persona | What it does | |----------|-----------------------------------------------------------| | trader | Send tx via Sender + Priority Fee API | | wallet | SOL + SPL + NFT + history snapshot via Wallet API + DAS | | indexer | Subscribe to Jupiter txs via LaserStream gRPC | | defi | Watch Pump AMM swaps via Enhanced WSS + Enhanced Tx parse | | nft | Fetch portfolio with metadata via DAS getAssetsByOwner | Seed projects under examples/quickstarts/<persona>/ Each is a self-contained Node project: package.json, src/index.ts, README.md, .env.example, tsconfig.json. Following the existing examples/gtfa-historical-token-accounts/ convention (ESM, tsx, dotenv). StackBlitz embed URL pattern: github.com/helius-labs/docs/tree/main/ examples/quickstarts/<persona>?file=src/index.ts. Persona picker landing quickstart.mdx (root) rewritten as a 5-card persona picker. The NFT-portfolio interactive demo that was the entire body of the page moved to /quickstart/nft (its persona-specific home). The picker includes a "not sure which one?" decision table and links to the three section-level choosers (chain-state, streaming, sending-transactions) for users beyond the 5-minute path. Nav Added a "Quickstart by persona" sub-group under Get Started. /quickstart sits as the picker landing; the 5 persona pages nest below. Audit - 366 EN pages, 338 in nav (up from 333). 5 new quickstarts + 1 picker rewrite folded in. - audit.csv prefilled for all 6 new/rewritten rows with diataxis_type, action, and persona_override. Validation - mint validate parses every new file cleanly. - Vale lint: zero banned words across the 5 quickstarts and 5 seed projects. - The 13 pre-existing mint validate warnings (zh/openapi schema issues + 2 missing-file warnings) are unchanged from main and unrelated to this PR. Notes - snippets/get-api-key.mdx and snippets/install-helius-sdk.mdx were drafted then dropped — Mintlify's MDX snippet imports require a React export, and inlining the 3-line API key step in each quickstart is simpler. snippets/quickstart.mdx (the existing interactive NFT React component) is now unreferenced but kept for potential reuse. - quickstart/nft.mdx links to /api-reference/das/getassetsbyowner and similar; those are existing pages. - All seed projects use TypeScript via tsx + ESM, matching the existing examples/ convention. Plan: ~/.claude/plans/users-kiryl-downloads-prd-plan-to-imple-cozy-badger.md Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
The 5 persona quickstart pages and the picker landing all linked to StackBlitz URLs (stackblitz.com/github/helius-labs/docs/...). Removing those for now — never validated they actually bootstrap correctly, and the helius-laserstream gRPC client in the indexer quickstart is the riskiest in WebContainer environments. The seed projects under examples/quickstarts/ stay — readers can clone the repo and run locally. Each quickstart page now links to the GitHub tree URL (github.com/helius-labs/docs/tree/main/examples/ quickstarts/<persona>) instead. Picker landing's lede also adjusted: \"copy-pasteable Node project and an 'Open in StackBlitz' link\" → \"copy-pasteable Node project you can also clone from examples/quickstarts/\". Re-test once the seed projects are validated end-to-end (PRD §WS-4 acceptance: n=3 external testers per persona) before re-introducing sandbox embeds. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
kiryl-xyz
force-pushed
the
feat/persona-quickstarts
branch
from
fbca09c to
1c1c863
Compare
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.
Stacked on #630 → #629 → #628. Week 3 of the redesign plan: the 5 persona quickstarts called out in PRD §WS-4.
Quickstarts
Each follows the PRD's 7-section template (Outcome, Prerequisites, Install, Run-it, Expected output, Troubleshooting, 3 Next-step cards) and is meant to be <5 minutes from sign-up to first working call.
Seed projects
Each quickstart has a matching runnable Node project under `examples/quickstarts//` with `package.json`, `src/index.ts`, `README.md`, `.env.example`, and `tsconfig.json`. Following the existing `examples/gtfa-historical-token-accounts/` convention (ESM, tsx, dotenv).
StackBlitz embed URL pattern: `github.com/helius-labs/docs/tree/main/examples/quickstarts/?file=src/index.ts`. Each quickstart page links to the corresponding StackBlitz.
Persona picker landing
The old root `quickstart.mdx` was a single NFT-portfolio walkthrough. Rewritten as a 5-card picker with a "not sure which one?" decision table and links to the section choosers (chain-state, streaming, sending-transactions). The original NFT content moved to its persona-specific home at `/quickstart/nft`.
Nav
New "Quickstart by persona" sub-group under Get Started.
Validation
Notes for review
🤖 Generated with Claude Code