fix(readme): Fix repo README and adjust publication readme content #49

frontegg-david · 2025-11-16T09:47:26Z

Summary by CodeRabbit

Documentation
- Restructured README: responsive header graphic, clearer TypeScript-centric mission, reworked Table of Contents, and guided CLI setup flow.
- Updated examples and defaults (now use port 3000), added reflect-metadata import in examples, clarified input schema examples, standardized commands (dev, build, inspector, doctor), and clarified tsconfig/ESM+decorators guidance.
Chores
- Raised Node.js minimum to 22+, added a top-level build script, and narrowed packaged documentation assets for CLI and SDK builds.

coderabbitai · 2025-11-16T09:47:33Z

Walkthrough

Updated README content and examples (hero image, TOC, port → 3000, added reflect-metadata import), narrowed build asset lists in libs/cli/project.json and libs/sdk/project.json to include only README.md, and added a root build npm script running nx run-many -t build.

Changes

Cohort / File(s)	Summary
Documentation `README.md`	Reworked hero to use a responsive `picture` element, reorganized the TOC and setup flow, emphasized TypeScript/decorators/DI/streamable HTTP, updated examples to import `reflect-metadata` and use port `3000`, adjusted snippets, commands, and deployment notes.
CLI build assets `libs/cli/project.json`	Restricted build assets to only include `README.md` instead of a glob matching `*.md`.
SDK build assets `libs/sdk/project.json`	Restricted build assets to only include `README.md` instead of a glob matching `*.md`.
Root scripts `package.json`	Added top-level `build` script: `nx run-many -t build`.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Inspect README for example correctness (port, reflect-metadata, CLI instructions).
Verify libs/cli/project.json and libs/sdk/project.json asset changes don't remove required files for packaging or consumers.
Confirm new root build script aligns with NX targets and CI workflows.

Possibly related PRs

fix: Fix docs and README #3 — Overlapping README and documentation edits; likely related to doc restructuring and examples.
fix(ci): Reversed version 0.3 due to bug in publishing workflow and fixed it #33 — Related changes to README handling and build/asset inclusion rules.

Poem

🐰 I hopped through README lines tonight,
Swapped banners for pictures, set the port just right,
Decorators twitched their whiskers in delight,
Nx gathers builds in one bounding flight,
Carrot-coded joy beneath the moonlight 🥕

Pre-merge checks and finishing touches

❌ Failed checks (1 inconclusive)

Check name	Status	Explanation	Resolution
Title check	❓ Inconclusive	The title mentions fixing the repo README, but the changeset encompasses broader modifications including project configuration changes (project.json files), package.json updates, and substantial README restructuring beyond simple fixes.	Consider clarifying whether this is a fix or a comprehensive update. If changes are substantive (new features, restructuring), use a more descriptive title like 'refactor(readme): Restructure README with TypeScript-centric approach and update build configs'.

✅ Passed checks (2 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✨ Finishing touches

🧪 Generate unit tests (beta)

Create PR with unit tests
Post copyable unit tests in a comment
Commit unit tests in branch update-readme-files

📜 Recent review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 9a3be6a and a104030.

📒 Files selected for processing (1)

README.md (7 hunks)

🧰 Additional context used

🪛 markdownlint-cli2 (0.18.1)

README.md

12-12: Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)

390-390: Link and image reference definitions should be needed
Unused link or image reference definition: "2"

(MD053, link-image-reference-definitions)

🔇 Additional comments (1)

README.md (1)

61-61: ✅ Previous critical and major issues resolved.

All reference definitions [1]–[13] are now properly defined (lines 389–401), and the TOC anchor at line 61 now correctly matches the combined heading ### Providers / Adapters / Plugins at line 274. Both the missing-definitions and anchor-mismatch issues from previous reviews have been addressed.

Also applies to: 274-274, 389-401

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

coderabbitai

Actionable comments posted: 1

🧹 Nitpick comments (1)

README.md (1)
12-12: Use a heading instead of emphasis for line 12.

Line 12 uses emphasis (_..._) but reads like a tagline that should be a proper heading or subheading. Consider using a heading level or clarifying the intent:
_Made with ❤️ for TypeScript developers_
This violates MD036 (no-emphasis-as-heading) per markdownlint. Either use ## (heading) or restructure the text.

📜 Review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 5624e20 and 722440b.

📒 Files selected for processing (4)

README.md (7 hunks)
libs/cli/project.json (1 hunks)
libs/sdk/project.json (1 hunks)
package.json (1 hunks)

🧰 Additional context used

🪛 markdownlint-cli2 (0.18.1)

README.md

12-12: Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)

61-61: Link fragments should be valid

(MD051, link-fragments)

62-62: Link fragments should be valid

(MD051, link-fragments)

63-63: Link fragments should be valid

(MD051, link-fragments)

92-92: Reference links and images should use a label that is defined
Missing link or image reference definition: "1"