Improve README structure, accuracy, and navigation - #28
Merged
Merged
Conversation
Co-authored-by: charles2ke <6725706+charles2ke@users.noreply.github.com>
Copilot created this pull request from a session on behalf of
charles2ke
September 20, 2026 18:26
View session
charles2ke
marked this pull request as ready for review
September 20, 2026 18:26
There was a problem hiding this comment.
Copilot review overview
🟢 Approval recommended
Documentation-only changes look accurate against the codebase, with only a minor Markdown formatting nit noted.
Review effort: Lite
Findings: 1
Open (1)
What changed in this PR
Reorganizes and refreshes the root README to improve navigation and accuracy for the service’s core GraphQL API, SSE streaming endpoint, CORS behavior, Excel export, and the optional finance integration surface.
Changes:
- Added badges, a quick-start block, and a table of contents to make the README easier to scan.
- Updated the project structure and testing listings to match the current repository tree.
- Reordered documentation sections (API → Streaming → CORS → Export → Finance) and added a security/license section.
| File | Description |
|---|---|
| README.md | Restructures and updates documentation content, navigation, and configuration details (no source changes). |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Co-authored-by: charles2ke <6725706+charles2ke@users.noreply.github.com>
charles2ke
approved these changes
Sep 20, 2026
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.

The README had grown to ~520 lines with a stale project-structure listing, finance internals ahead of the core API docs, and CORS buried inside the Streaming section. This reorganizes and corrects it; documentation-only, no source changes.
Navigation
Contentstable of contents.Quick startblock (clone → install → start → test) and merged the duplicateInstallation/Running locallysections.Accuracy
cache/,observability/,validation/,config/(finance + cors), and all eight test files.PORTto the configuration table, with a note that the last rows (LOG_LEVEL,CORS_ALLOWED_ORIGINS,PORT) are read outsideconfig/finance.js.Ordering
/graphql,/graphql/stream, and/export, not just streaming).Security and licensesection linkingSECURITY.mdandLICENSE.API table
Grouped by operation type and cross-linked to the finance and streaming sections: