docs(readme): modularize setup docs across root, backend, and frontend - #312
Merged
DenizAltunkapan merged 3 commits intoAug 6, 2026
Merged
Conversation
shardool-patil
requested review from
DenizAltunkapan and
GabrielBBaldez
as code owners
August 5, 2026 17:29
Member
|
@shardool-patil please fix the failing workflows |
Contributor
Author
|
@DenizAltunkapan I have fixed the failing workflows, just take a look. |
DenizAltunkapan
requested changes
Aug 6, 2026
DenizAltunkapan
left a comment
DenizAltunkapan
left a comment
Member
There was a problem hiding this comment.
@shardool-patil Three small fixes, all in frontend/README.md.
Lines 64, 66 and 109 — backticks were dropped around public/runtime-config.local.js and dist/; they were code-formatted before.
Fix those and I'll approve.
DenizAltunkapan
approved these changes
Aug 6, 2026
DenizAltunkapan
left a comment
DenizAltunkapan
left a comment
Member
There was a problem hiding this comment.
@shardool-patil thank you for your contribution
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
2 participants
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.
Summary
Restructured repository documentation by modularizing setup instructions and moving module-specific details out of the root
README.mdinto dedicated backend and frontend documentation:README.md: Converted into a high-level entry point containing an ecosystem overview, module/dependency links, quickstart guide, and troubleshooting resources. Removed duplicated module configuration details.backend/README.md: Documented module responsibilities, standalone execution instructions, unit testing commands, package structure, HTTP/HTTPS dev modes, and timezone troubleshooting notes.frontend/README.md: Stripped out generic Angular CLI boilerplate while preserving Vault Web runtime configuration (runtime-config.local.jsandforwardVaultWebTokenhandoff). Integrated HTTP/HTTPS dev server modes, unit testing steps, and directory structure layout.Linked issue
Closes #310
How to test
README.mdand verify that high-level links, quickstart commands, and ecosystem descriptions render cleanly.backend/and checkbackend/README.mdto ensure all standalone backend setup steps, HTTP/HTTPS modes, and testing instructions are clear and accurate.frontend/and checkfrontend/README.mdto confirm that Angular CLI boilerplate is removed and runtime configuration / dev server modes are accurately documented.Notes / Risk