Skip to content

Document and test all four error pages' recovery flows in ERROR_PAGES_README.md #661

Description

@1nonlypiece

📌 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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No fields configured for Task.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions