Skip to content

Replace the README placeholder upstream link and document the dashboard routes #23

Description

@mikewheeleer

Document the dashboard routes and fix the README placeholder link

Description

README.md still points at https://github.com/your-org/stableroute and says only "Starter landing page; Stellar wallet integration can be added here", which no longer matches the app — there are real pages for pairs, quote, stats, admin, api-keys, events, webhooks, settings, and docs. This issue brings the README in line with the actual feature set.

Requirements and context

  • Repository scope: StableRoute-Org/Stableroute-frontend only.
  • Replace the placeholder upstream URL with the correct StableRoute org link and update the project description.
  • Add a "Routes" section enumerating each page under src/app with a one-line purpose, linking to the source files.
  • Document the NEXT_PUBLIC_STABLEROUTE_API_BASE env var and the API endpoints the UI consumes (/api/v1/pairs, /quote, /stats, /admin/*, /api-keys, /events, /webhooks).
  • Keep the existing scripts and CI sections accurate.

Suggested execution

  • Fork the repo and create a branch
  • git checkout -b docs/readme-23-routes-and-links
  • Implement changes
    • Write code in: n/a (docs).
    • Write comprehensive tests in: n/a — verify links resolve and npm run build still passes.
    • Add documentation: rewrite the relevant sections of README.md.
    • Ensure every referenced file path exists in the repo.
    • Validate Markdown renders cleanly.
  • Test and commit

Test and commit

  • Run npm run lint and npm run build to confirm nothing references removed content.
  • Cover edge cases: all route links valid, env var documented, and no stale "wallet integration can be added" copy.
  • Include a rendered preview note in the PR description.

Example commit message

docs: document dashboard routes and fix README upstream link

Guidelines

  • Minimum 95 percent test coverage for impacted modules.
  • Clear, reviewer-focused documentation.
  • Timeframe: 96 hours.

Community & contribution rewards

  • 💬 Join the StableRoute community on Discord for questions, reviews, and faster merges: https://discord.gg/37aCpusvx
  • ⭐ 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 — if this issue and the maintainers helped you ship, we'd be grateful for a 5-star rating. Clear questions in Discord and tidy, well-tested PRs are the fastest path to a merge and a reward.

Metadata

Metadata

Assignees

No fields configured for Feature.

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions