Document navigation
Description
The navigation component's props and usage are undocumented, leading to inconsistent use. This issue adds a concise reference.
Requirements and context
- Repository scope: Agentpay-Org/Agentpay-frontend only.
- Add a docs entry covering navigation's props, states, and a minimal usage example.
- Keep it accurate to the current API; read the component first.
- Link from the docs index if one exists.
Suggested execution
- Fork the repo and create a branch
git checkout -b docs/navigation-01-component
- Implement changes
- Write code in: the relevant module.
- Write comprehensive tests in: cover the new behaviour and edge cases.
- Test and commit
Test and commit
- Run
npm run lint, npm test, and npm run build.
- Cover edge cases: n/a — verify props against source.
- Include the full test output in the PR description.
Example commit message
docs(navigation): document component contract
Guidelines
- Minimum 95 percent test coverage for impacted modules.
- Clear, reviewer-focused documentation.
- Timeframe: 96 hours.
Community & contribution rewards
- 💬 Join the AgentPay community on Discord: https://discord.gg/eXvRKkgcv
- ⭐ This is a GrantFox OSS / Official Campaign task and may be rewarded. When your PR is merged you'll be prompted to rate the project — a 5-star rating is much appreciated.
Document navigation
Description
The navigation component's props and usage are undocumented, leading to inconsistent use. This issue adds a concise reference.
Requirements and context
Suggested execution
git checkout -b docs/navigation-01-componentTest and commit
npm run lint,npm test, andnpm run build.Example commit message
docs(navigation): document component contractGuidelines
Community & contribution rewards