docs: document dashboard routes and fix README upstream link#32
Open
akprinciple wants to merge 1 commit into
Open
docs: document dashboard routes and fix README upstream link#32akprinciple wants to merge 1 commit into
akprinciple wants to merge 1 commit into
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Pull Request Description
Title
docs: update README to align with actual application routes and API integrationcloses #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
docs/readme-23-routes-and-links)Key Changes
Upstream Link & Description Update:
https://github.com/your-org/stableroutewith the correct StableRoute linkhttps://github.com/StableRoute-Org/Stableroute.New Routes Section:
src/appwith a brief one-line description of their purpose:/)/pairsand/pairs/new)/quote)/stats)/admin)/api-keys)/events)/webhooks)/settings)/docs)/about)API Integration & Env Vars:
NEXT_PUBLIC_STABLEROUTE_API_BASEenvironment variable./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
✓ 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
├ 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
✔ No ESLint warnings or errors