Skip to content

docs: document dashboard routes and fix README upstream link#32

Open
akprinciple wants to merge 1 commit into
StableRoute-Org:mainfrom
akprinciple:docs/readme-23-routes-and-links
Open

docs: document dashboard routes and fix README upstream link#32
akprinciple wants to merge 1 commit into
StableRoute-Org:mainfrom
akprinciple:docs/readme-23-routes-and-links

Conversation

@akprinciple

Copy link
Copy Markdown

Pull Request Description

Title

docs: update README to align with actual application routes and API integration
closes #23

Description

This pull request updates the main project README.md to accurately reflect the actual page routes, environment configurations, and backend API endpoints consumed by the frontend.

Previously, the README contained placeholder upstream links and suggested that the repository only held a starter landing page. This PR align the documentation with the fully implemented Next.js pages.

Related Issues

Key Changes

  1. Upstream Link & Description Update:

    • Swapped the placeholder repository link https://github.com/your-org/stableroute with the correct StableRoute link https://github.com/StableRoute-Org/Stableroute.
    • Updated the project description to focus on the StableRoute Stellar liquidity routing protocol and its dashboard/management pages.
  2. New Routes Section:

    • Added a detailed directory mapping all pages under src/app with a brief one-line description of their purpose:
      • Home/Landing (/)
      • Pairs Management (/pairs and /pairs/new)
      • Routing Quotes (/quote)
      • Dashboard Metrics (/stats)
      • Admin Pauser (/admin)
      • API Keys Credentialing (/api-keys)
      • Audit Logs (/events)
      • Webhook Configuration (/webhooks)
      • Appearance Customization (/settings)
      • Developer Docs (/docs)
      • Static Protocol Overview (/about)
  3. API Integration & Env Vars:

    • Documented the NEXT_PUBLIC_STABLEROUTE_API_BASE environment variable.
    • Listed all backend REST API endpoints consumed by the client logic (/api/v1/pairs, /api/v1/quote, /api/v1/stats, /api/v1/admin/*, /api/v1/api-keys, /api/v1/events, and /api/v1/webhooks).

Verification & Testing

  • Validated markdown formatting on local rendering.
  • Inspected the correctness of all relative source file paths mapped to page descriptions.

✓ Compiled successfully
✓ Linting and checking validity of types
✓ Collecting page data
✓ Generating static pages (15/15)
✓ Collecting build traces
✓ Finalizing page optimization

Route (app) Size First Load JS
┌ ○ / 175 B 109 kB
├ ○ /_not-found 144 B 100 kB
├ ○ /about 144 B 100 kB
├ ○ /admin 1.13 kB 101 kB
├ ○ /api-keys 1.46 kB 101 kB
├ ○ /docs 144 B 100 kB
├ ○ /events 1.07 kB 101 kB
├ ○ /pairs 1.15 kB 110 kB
├ ○ /pairs/new 1.26 kB 101 kB
├ ○ /quote 1.49 kB 101 kB
├ ○ /settings 685 B 101 kB
├ ○ /stats 1.04 kB 101 kB
└ ○ /webhooks 1.44 kB 101 kB

  • First Load JS shared by all 99.9 kB
    ├ chunks/4bd1b696-778553b9b849b394.js 52.5 kB
    ├ chunks/517-efb5183cf88147b3.js 45.5 kB
    └ other shared chunks (total) 1.91 kB

○ (Static) prerendered as static content

USER@Leotechworld MINGW64 ~/Desktop/soroban-cook/Stableroute-frontend (docs/readme-23-routes-and-links)
$ npm run lint

stableroute-frontend@0.1.0 lint
next lint

✔ No ESLint warnings or errors

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.

Replace the README placeholder upstream link and document the dashboard routes

1 participant