docs: refresh README landing page#506
Merged
Merged
Conversation
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
📝 WalkthroughWalkthroughThe README was rewritten into a concise npm-facing landing page (Why, Install, Quick Start, Supported Agents, Use Without MCP, What It Builds, Fit, Freshness, Evidence, Privacy, Telemetry, What's New, Docs) and the contributors section markup and acknowledgement were updated. Multiple unit tests were adjusted to align assertions with the new README and relocated deeper docs. ChangesREADME Landing Page Restructure
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes Possibly related PRs
Poem
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
Comment |
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
🧹 Nitpick comments (1)
tests/unit/why-madar-doc.test.ts (1)
88-93: ⚡ Quick winAvoid hard-coding the release version in docs assertions.
Pinning
0.27.9here will force test edits on every release. Readpackage.jsonand assert against the current manifest version instead.♻️ Proposed update
+interface PackageManifest { + version?: string +} + +function loadPackageManifest(): PackageManifest { + return JSON.parse(readDoc('package.json')) as PackageManifest +} + describe('public marketing copy honesty', () => { @@ - it('surfaces the current stable release and benchmark evidence pointers in the main README flow', () => { - expect(content).toContain('Current version: `0.27.9`') - expect(content).toContain('0.27.9 changelog') + it('surfaces the current stable release and benchmark evidence pointers in the main README flow', () => { + const manifest = loadPackageManifest() + expect(content).toContain(`Current version: \`${manifest.version}\``) + expect(content).toContain(`${manifest.version} changelog`) expect(content).toContain('madar summary') expect(content).toContain('docs/claims-and-evidence.md') expect(content).toContain('docs/benchmarks/suite/') })🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@tests/unit/why-madar-doc.test.ts` around lines 88 - 93, The test "surfaces the current stable release and benchmark evidence pointers in the main README flow" hard-codes '0.27.9'; instead read package.json version and assert against it. In tests/unit/why-madar-doc.test.ts import or require the project's package.json to get packageJson.version, then replace the literal expect(content).toContain('Current version: `0.27.9`') with an assertion that interpolates the runtime version (e.g., expect(content).toContain(`Current version: \`${packageJson.version}\``)); leave the other static README checks (e.g., '0.27.9 changelog') updated to use the same version variable if they refer to the release string. Ensure you reference the test's content variable and the test title when making the change.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Nitpick comments:
In `@tests/unit/why-madar-doc.test.ts`:
- Around line 88-93: The test "surfaces the current stable release and benchmark
evidence pointers in the main README flow" hard-codes '0.27.9'; instead read
package.json version and assert against it. In tests/unit/why-madar-doc.test.ts
import or require the project's package.json to get packageJson.version, then
replace the literal expect(content).toContain('Current version: `0.27.9`') with
an assertion that interpolates the runtime version (e.g.,
expect(content).toContain(`Current version: \`${packageJson.version}\``)); leave
the other static README checks (e.g., '0.27.9 changelog') updated to use the
same version variable if they refer to the release string. Ensure you reference
the test's content variable and the test title when making the change.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro Plus
Run ID: b8bad980-b375-44eb-8180-aa5d21d41bef
📒 Files selected for processing (11)
README.mdtests/unit/benchmark-suite-docs.test.tstests/unit/design-partners-doc.test.tstests/unit/getting-started-docs.test.tstests/unit/install-compatibility.test.tstests/unit/install-docs.test.tstests/unit/launch-checklist-doc.test.tstests/unit/package-metadata.test.tstests/unit/rebrand-surface.test.tstests/unit/sample-workspace.test.tstests/unit/why-madar-doc.test.ts
💤 Files with no reviewable changes (3)
- tests/unit/sample-workspace.test.ts
- tests/unit/design-partners-doc.test.ts
- tests/unit/launch-checklist-doc.test.ts
✅ Files skipped from review due to trivial changes (1)
- README.md
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
1 participant
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
Testing
Summary by CodeRabbit