Skip to content

docs(gas-sponsorship): add dashboard guide for redesigned policies - #1434

Open
Richard-Dang wants to merge 18 commits into
mainfrom
rdang/TXE-308-gas-sponsorship-docs-guide
Open

docs(gas-sponsorship): add dashboard guide for redesigned policies#1434
Richard-Dang wants to merge 18 commits into
mainfrom
rdang/TXE-308-gas-sponsorship-docs-guide

Conversation

@Richard-Dang

Copy link
Copy Markdown
Contributor

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-sponsorship route.

Key changes

  • New 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.
  • Wire the guide into content/docs.yml under the Sponsor gas section, and link to it from sponsor-gas/overview.mdx (new Card) and the legacy setup-a-gas-manager-policy tutorial (Info pointer).
  • Update all ~46 stale legacy Gas Manager dashboard deep-links across 38 files (gas-policies/new, services/gas-manager/configuration, gas-manager, gas-manager/policy/create) to https://dashboard.alchemy.com/apps/latest/gas-sponsorship.

Technical details

The guide follows the wallet docs conventions (second person, "sponsor gas" terminology, relative /docs/... links, Steps for the create procedure). Policy-type labels and per-type tab sets are sourced from the dashboard code: PolicyType / POLICY_TYPE_LABELS in policyOptions.ts and getEditorTabIds in editorTabs.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 GasSponsorshipRedesignEnabled ON. The Cloudinary URLs are currently placeholders (v_TODO); the source PNGs are in the worktree under screenshots-todo/ (not committed) pending Cloudinary upload. Once uploaded, the four v_TODO URLs 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

  • New single-page dashboard guide exists under content/wallets/pages/transactions/sponsor-gas/ and is wired into content/docs.yml under the Sponsor gas section
  • Guide walks through creating a policy and documents all 4 redesigned policy types (sponsorship, solana, erc20, bundler_sponsorship) with when-to-use guidance and the per-type rule tabs
  • Guide embeds fresh screenshots of the redesigned dashboard (flag ON) uploaded to Cloudinary, never committed to git — pending Cloudinary upload
  • All stale legacy dashboard deep-links in content/ updated to the redesigned /gas-sponsorship route
  • Broken-links check passes — pending Cloudinary URLs; will re-run pnpm lint:broken-links (needs .env) or verify via the PR preview once images are hosted

Docs-repo acceptance criteria (dashboard-tab wiring lives in the companion dashboard PR #8106):

  • Docs static checks pass: pnpm lint, pnpm validate:docs-yml, pnpm test:run

Testing

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 eslint and pnpm exec prettier --check over 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 new dashboard-guide slug against content/ and docs.yml). External dashboard links point at the canonical redesigned route. pnpm lint:broken-links requires .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:run covers existing scripts/utils and stays green).

Linear Task

TXE-308

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
@github-actions

github-actions Bot commented Jul 7, 2026

Copy link
Copy Markdown

🔗 Preview Mode

Name Status Preview Updated (UTC)
Alchemy Docs ✅ Ready 🔗 Visit Preview Aug 10, 2026, 9:51 PM

…nsorship-docs-guide

# Conflicts:
#	content/docs.yml
Drop the redesign flag, match create-modal and Usage Current usage copy, and note ERC-20 networks are per-token after the Configured networks multiselect was removed.
…hots

Replace v_TODO placeholders with the uploaded create-policy, ERC-20 editor, and Usage tab images.
Link the dashboard URL, drop fragile modal copy and API field names, fix the policy-types anchor, and align status badges with active/inactive/expired only.
@Richard-Dang
Richard-Dang marked this pull request as ready for review August 10, 2026 18:28
@Richard-Dang
Richard-Dang requested a review from a team as a code owner August 10, 2026 18:28

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: dcbd3fadb5

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread content/wallets/pages/transactions/sponsor-gas/dashboard-guide.mdx Outdated
Comment thread content/docs.yml Outdated
Comment thread content/wallets/pages/core/quickstart.mdx Outdated
Comment thread content/wallets/pages/transactions/sponsor-gas/overview.mdx Outdated
Comment thread content/wallets/pages/transactions/sponsor-gas/dashboard-guide.mdx Outdated
Comment thread content/wallets/pages/transactions/sponsor-gas/dashboard-guide.mdx Outdated
Comment thread content/wallets/pages/transactions/sponsor-gas/dashboard-guide.mdx Outdated
Comment thread content/wallets/pages/transactions/sponsor-gas/dashboard-guide.mdx Outdated
Comment thread content/wallets/pages/transactions/pay-gas-with-any-token/index.mdx Outdated
Comment thread content/wallets/pages/transactions/sponsor-gas/dashboard-guide.mdx Outdated
Comment thread content/wallets/pages/transactions/sponsor-gas/overview.mdx Outdated
Richard-Dang and others added 5 commits August 10, 2026 15:55
Rename nav to Policy Management, prefer the guide over raw dashboard deep-links, drop redesign copy, use dialog wording, and collapse rule sections into accordions.
Point the tutorial at Policy Management without calling out the redesign.
Match the Policies tab behavior: the button stays visible and disables with a tooltip when EditAppConfig is missing.
Rewrite the intro in plain UI nouns after review feedback that
"opening the surface" read as unedited AI copy.
@jakehobbs
jakehobbs self-requested a review August 10, 2026 20:17
Comment thread content/wallets/pages/transactions/sponsor-gas/sponsorship-policy-management.mdx Outdated
Comment thread content/wallets/pages/transactions/sponsor-gas/sponsorship-policy-management.mdx Outdated
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.

3 participants