Skip to content

Update README files for the monorepo architecture#36

Merged
ben-z merged 1 commit intomainfrom
benz/readmes
Jul 2, 2025
Merged

Update README files for the monorepo architecture#36
ben-z merged 1 commit intomainfrom
benz/readmes

Conversation

@ben-z
Copy link
Member

@ben-z ben-z commented Jun 29, 2025

This PR updates README files for the monorepo. Follow-up to #34

@ben-z ben-z requested review from alexboden and Copilot June 29, 2025 21:37
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR introduces and updates README documentation across all packages to align with the new monorepo structure and standardize usage and development instructions.

  • Add README for the utils package with usage and development details
  • Add README for the ts-config package and update template and CLI READMEs
  • Create a top-level README outlining all core packages and applications

Reviewed Changes

Copilot reviewed 5 out of 5 changed files in this pull request and generated 1 comment.

Show a summary per file
File Description
packages/utils/README.md New documentation for shared utilities
packages/ts-config/README.md New documentation for shared TypeScript config
packages/templates/README.md Updated development and build instructions for email templates
apps/cli/README.md New CLI documentation with development, build, usage, and install steps
README.md Top-level monorepo overview and package index
Comments suppressed due to low confidence (1)

packages/templates/README.md:9

  • It’s helpful to install dependencies before starting the dev server. Consider adding npm ci (or npm install) on the previous line.
   npm run dev

@ben-z ben-z merged commit 974ece1 into main Jul 2, 2025
1 check passed
@ben-z ben-z deleted the benz/readmes branch July 2, 2025 04:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants