docs(gas-sponsorship): add dashboard guide for redesigned policies#1434
Draft
Richard-Dang wants to merge 1 commit into
Draft
docs(gas-sponsorship): add dashboard guide for redesigned policies#1434Richard-Dang wants to merge 1 commit into
Richard-Dang wants to merge 1 commit into
Conversation
Add a single-page walkthrough of the redesigned Gas Sponsorship dashboard under sponsor-gas/dashboard-guide, covering opening the surface, creating a policy, the four policy types and when to use each, per-type rule tabs, going live, and monitoring spend on the Usage tab. Wire it into docs.yml under the Sponsor gas section and link to it from the overview page and the legacy gas-manager policy tutorial. Update every stale legacy Gas Manager dashboard deep-link across content/ to the redesigned app-scoped /gas-sponsorship route. Screenshot Cloudinary URLs are placeholders pending upload; source PNGs are in the worktree under screenshots-todo/ (not committed). Linear: TXE-308
🔗 Preview Mode
|
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.
Summary
Adds a single-page walkthrough of the redesigned Gas Sponsorship dashboard and updates every stale legacy Gas Manager dashboard deep-link across
content/to the redesigned app-scoped/gas-sponsorshiproute.Key changes
content/wallets/pages/transactions/sponsor-gas/dashboard-guide.mdx: opening the surface, creating a policy via the 2-step modal, the four policy types and when to use each, per-type rule tabs, going live, and monitoring spend on the Usage tab.content/docs.ymlunder the Sponsor gas section, and link to it fromsponsor-gas/overview.mdx(new Card) and the legacysetup-a-gas-manager-policytutorial (Info pointer).gas-policies/new,services/gas-manager/configuration,gas-manager,gas-manager/policy/create) tohttps://dashboard.alchemy.com/apps/latest/gas-sponsorship.Technical details
The guide follows the wallet docs conventions (second person, "sponsor gas" terminology, relative
/docs/...links,Stepsfor the create procedure). Policy-type labels and per-type tab sets are sourced from the dashboard code:PolicyType/POLICY_TYPE_LABELSinpolicyOptions.tsandgetEditorTabIdsineditorTabs.ts.Screenshots: the guide embeds four screenshots of the redesigned surface (create type picker, create chain selection, ERC-20 editor, Usage tab) captured from the running redesigned dashboard with
GasSponsorshipRedesignEnabledON. The Cloudinary URLs are currently placeholders (v_TODO); the source PNGs are in the worktree underscreenshots-todo/(not committed) pending Cloudinary upload. Once uploaded, the fourv_TODOURLs will be replaced with the secure Cloudinary URLs and the broken-links check re-run. Do not merge until the Cloudinary URLs are substituted.Acceptance criteria
content/wallets/pages/transactions/sponsor-gas/and is wired intocontent/docs.ymlunder the Sponsor gas sectionsponsorship,solana,erc20,bundler_sponsorship) with when-to-use guidance and the per-type rule tabscontent/updated to the redesigned/gas-sponsorshiproutepnpm lint:broken-links(needs.env) or verify via the PR preview once images are hostedDocs-repo acceptance criteria (dashboard-tab wiring lives in the companion dashboard PR #8106):
pnpm lint,pnpm validate:docs-yml,pnpm test:runTesting
Static checks (all green):
pnpm validate:docs-yml(docs.yml nav structure),pnpm test:run(vitest, 233 tests),pnpm run typecheck(tsc --noEmit),pnpm exec eslintandpnpm exec prettier --checkover all 43 changed files.Manual link verification: every new internal link resolves to an existing file (verified
conditional-sponsorship-rules,pay-gas-with-any-token,solana,low-level-infra/gas-manager/policy-management/api-endpoints, and the newdashboard-guideslug againstcontent/anddocs.yml). External dashboard links point at the canonical redesigned route.pnpm lint:broken-linksrequires.env(lychee + Algolia/Redis), so the final broken-link pass runs in the PR preview once the Cloudinary screenshot URLs are substituted.New test files: none (MDX content;
pnpm test:runcovers existing scripts/utils and stays green).Linear Task
TXE-308