ProDocs 1.2.1: fix and validate generated view links - #22
Conversation
|
Warning Review limit reached
Next review available in: 56 minutes You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository. How can I continue?After more reviews become available, a review can be triggered using the To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews. How do review limits work?CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability. For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window. Please refer docs for additional details. Review details⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (11)
📝 WalkthroughWalkthroughThe release adds generated Markdown link validation, updates CLI check states and JSON output, corrects nested audience-view links and empty states, refreshes generated documentation metadata, and increments the project version to 1.2.1. ChangesGenerated documentation validation and release
Estimated code review effort: 3 (Moderate) | ~20 minutes Sequence Diagram(s)sequenceDiagram
participant CLI
participant generatedLinks
participant FileSystem
CLI->>generatedLinks: validateGeneratedLinks(root, config)
generatedLinks->>FileSystem: Read generated Markdown artifacts
FileSystem-->>generatedLinks: Markdown content or link issues
generatedLinks-->>CLI: validLinks and linkIssues
CLI->>generatedLinks: documentationCheckState(...)
generatedLinks-->>CLI: Check readiness
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✨ Finishing Touches 💡 1📝 Generate docstrings 💡
🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
🧹 Nitpick comments (1)
test/render.test.js (1)
85-92: 📐 Maintainability & Code Quality | 🔵 Trivial | ⚡ Quick winCover the changed audience branches.
This test configures only
productandtechnicalaudiences and checks only the product fallback. The changes insrc/render.jsalso alter thesupport,security, andoperationsempty states. Add cases for those branches, or callrenderAudienceViewdirectly, so regressions in those messages fail the test.🤖 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 `@test/render.test.js` around lines 85 - 92, Extend the render tests around the existing product fallback assertions to cover the support, security, and operations audience branches changed in renderAudienceView. Configure or invoke renderAudienceView for each audience with empty-state input, then assert the expected generated message for each while preserving the existing link validation.
🤖 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 `@test/render.test.js`:
- Around line 85-92: Extend the render tests around the existing product
fallback assertions to cover the support, security, and operations audience
branches changed in renderAudienceView. Configure or invoke renderAudienceView
for each audience with empty-state input, then assert the expected generated
message for each while preserving the existing link validation.
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro Plus
Run ID: 138ff91f-c6e5-45e9-a63c-477750d213c2
⛔ Files ignored due to path filters (1)
package-lock.jsonis excluded by!**/package-lock.json
📒 Files selected for processing (23)
CHANGELOG.mdREADME.mddocs/MATURITY.mddocs/SUPPLY_CHAIN.mddocs/VALIDATION.mddocs/prodocs/CODE_MAP.mddocs/prodocs/KNOWLEDGE_HEALTH.mddocs/prodocs/SYSTEM_OVERVIEW.mddocs/prodocs/knowledge.jsondocs/prodocs/manifest.jsondocs/prodocs/views/coding-agents.mddocs/prodocs/views/operations.mddocs/prodocs/views/product.mddocs/prodocs/views/security.mddocs/prodocs/views/support.mddocs/prodocs/views/technical.mdpackage.jsonsrc/cli.jssrc/constants.jssrc/generated-links.jssrc/render.jstest/cli.test.jstest/render.test.js
1 participant
Outcome
Fixes nested audience-view links that were calculated from the output root, replaces misleading generic empty states with section-specific messages, and makes
prodocs checkfail on broken generated local links.Kourti validation
validLinks: trueProduction gates
Summary by CodeRabbit
New Features
checkto report link health and fail when links are invalid or documentation is stale.Bug Fixes
Documentation