feat: add/reorder package readme#783
Merged
diegomayorga-dept merged 2 commits intoJun 4, 2026
Merged
Conversation
Kevin Loftus (kevin-loftus-dept)
approved these changes
Jun 3, 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.
Title*
docs: replace package-level README stubs (DOCS-07)
Type of Change*
Description
The three package-level READMEs (
packages/back-end,packages/front-end,packages/shared-lib) were each a 1-line# replace thisplaceholder, leaving a new contributor opening any package with zero orientation. This replaces each stub with a concise (~30-line) overview following one shared structure: what the package is → key directories → running locally → where to look next.Each README links into the in-repo
docs/structure (created in DOCS-04) rather than duplicating content:docs/development/local-backend-dev.mdanddocs/development/contributing.md.pnpm devto run.nftower-spec-to-zod); where the sharedHttpErrorsubtypes live.Design note: the ticket suggested linking into
CLAUDE.md, butCLAUDE.mdis not tracked in this repo (it lives at the workspace root), so those links would render broken on GitHub. Architecture/convention guidance is therefore described briefly inline and links point only at in-repodocs/targets.Relates to DOCS-07 (EGV-169). Depends on DOCS-04 (docs restructure, already merged) so the
docs/links resolve.Testing*
Documentation-only change — no application code touched, so no automated tests apply. Verified manually:
docs/README.md,docs/development/contributing.md,docs/development/local-backend-dev.md,packages/shared-lib/src/app/utils/HttpError.ts, and the nf-tower spec.CLAUDE.mdreferences remain in any package README.Impact
Documentation only. No runtime, build, dependency, or behavioural changes. Improves contributor onboarding by giving each package a clear entry point into the
docs/structure.Additional Information
Follow-up worth a separate ticket:
CLAUDE.mdandARCHITECTURE.mdare not tracked in this repo, so deeper architecture links currently have no in-repo target. Committing them (or an in-repo architecture doc) would let these READMEs link to canonical convention/architecture references.Checklist*