📌 Description
ERROR_PAGES_README.md exists but does not fully document the behaviour and
recovery actions of the live error surfaces (error.tsx, not-found.tsx,
network-error, transaction-error), including how transaction-error maps
error categories to recovery CTAs. Contributors lack a single reference for the
intended UX of each error state.
This issue brings ERROR_PAGES_README.md up to date with the implemented pages
and their recovery flows, with a small drift-guard test.
🎯 Requirements and Context
- Document each error page's purpose, triggers, copy, and recovery actions.
- Document the
transaction-error category→CTA mapping and network-error
retry/countdown behaviour.
- Cross-link from
README.md.
- Add a test that the documented page paths exist (guard against drift).
🛠️ Suggested Execution
1. Fork the repo and create a branch
git checkout -b docs/error-pages-readme
2. Implement changes
- Update
ERROR_PAGES_README.md to reflect the current pages and flows.
- Add
src/app/__tests__/errorPagesDoc.test.ts asserting documented page paths
exist and key recovery CTAs are present.
- Validate the doc matches the implemented behaviour.
3. Test and commit
- Run
pnpm test.
- Cover edge cases: missing page flagged, CTA label drift, new error route added.
Example commit message
docs: update ERROR_PAGES_README with recovery flows and drift test
✅ Guidelines
- Minimum 95% test coverage on the drift-guard helper.
- Clear, reviewer-friendly documentation.
- Timeframe: 96 hours.
🏷️ Labels
type-documentation · area-frontend · MAYBE REWARDED · GRANTFOX OSS ·
OFFICIAL CAMPAIGN
💬 Community & Support
- Join the CommitLabs contributor Discord to coordinate and get unblocked fast:
https://discord.gg/WV7tdYkJk
- Introduce yourself before starting so we can avoid duplicate work and pair you
with a reviewer. Maintainers triage actively and review fast.
📌 Description
ERROR_PAGES_README.mdexists but does not fully document the behaviour andrecovery actions of the live error surfaces (
error.tsx,not-found.tsx,network-error,transaction-error), including howtransaction-errormapserror categories to recovery CTAs. Contributors lack a single reference for the
intended UX of each error state.
This issue brings
ERROR_PAGES_README.mdup to date with the implemented pagesand their recovery flows, with a small drift-guard test.
🎯 Requirements and Context
transaction-errorcategory→CTA mapping andnetwork-errorretry/countdown behaviour.
README.md.🛠️ Suggested Execution
1. Fork the repo and create a branch
2. Implement changes
ERROR_PAGES_README.mdto reflect the current pages and flows.src/app/__tests__/errorPagesDoc.test.tsasserting documented page pathsexist and key recovery CTAs are present.
3. Test and commit
pnpm test.Example commit message
✅ Guidelines
🏷️ Labels
type-documentation·area-frontend·MAYBE REWARDED·GRANTFOX OSS·OFFICIAL CAMPAIGN💬 Community & Support
https://discord.gg/WV7tdYkJk
with a reviewer. Maintainers triage actively and review fast.