Conversation
There was a problem hiding this comment.
Pull Request Overview
This PR updates and expands the project’s README files to include documentation for the shared module, enhance the REST module docs, and add a new Shared section to the root README.
- Add basic overview for the
server/sharedmodule. - Expand
server/restREADME with version, base URL, docs link, file structure, and module summaries. - Update the top-level README to include a Shared entry in the table of contents and a docs link for REST.
Reviewed Changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| apps/server/shared/README.MD | Add Shared module README with bullet points for network calls and types. |
| apps/server/rest/README.MD | Enhance REST README: versioning, endpoints, file structure, and module docs. |
| README.MD | Update root TOC to include Shared section and add REST docs link. |
Comments suppressed due to low confidence (1)
apps/server/rest/README.MD:4
- [nitpick] Use consistent capitalization and punctuation for keys. Change 'base url' to 'Base URL:' and consider placing the URL on the same line for clarity.
- base url
| @@ -0,0 +1,4 @@ | |||
| # @Server/Shared | |||
|
|
|||
| - internal network call | |||
There was a problem hiding this comment.
The bullet 'internal network call' is very high-level; consider expanding it with specifics (e.g., service names or endpoints) to give readers clearer context.
| - internal network call | |
| - Internal network call to the User Authentication Service for verifying user credentials. |
|
|
||
| ## modules | ||
|
|
||
| rest api endpoints |
There was a problem hiding this comment.
[nitpick] Standardize casing for acronyms. Change 'rest api endpoints' to 'REST API endpoints' to match other headings.
| rest api endpoints | |
| REST API endpoints |
| ### Rest | ||
|
|
||
| - production: https://api.zerovoyage.com | ||
| - docs: https://api.zerovoyage.com/docs |
There was a problem hiding this comment.
[nitpick] Capitalize list labels consistently (e.g., 'Docs:' instead of 'docs:') to match other items like 'Production:' and 'GitHub:'.
| - docs: https://api.zerovoyage.com/docs | |
| - Docs: https://api.zerovoyage.com/docs |
No description provided.