docs: move hang watch/publish guides into their own packages - #1613
Conversation
The @moq/hang docs duplicated watch/publish guides that the dedicated @moq/watch and @moq/publish pages already cover more thoroughly. Remove the hang/watch.md and hang/publish.md subsections, collapse the nested sidebar entry, and point hang's "Next Steps" links at the dedicated package pages. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
WalkthroughThis PR reorganizes the documentation structure for the 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches✨ Simplify code
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 |
There was a problem hiding this comment.
🧹 Nitpick comments (1)
doc/.vitepress/config.ts (1)
194-194: ⚡ Quick winRemove trailing slash for consistency.
The
@moq/hanglink has a trailing slash (/lib/js/@moq/hang/), but all other leaf package entries in this sidebar section omit it (lines 193, 195-198). Since@moq/hangno longer has nested items, it should follow the same pattern as the other leaf entries for navigation consistency.📝 Proposed fix
-{ text: "`@moq/hang`", link: "/lib/js/@moq/hang/" }, +{ text: "`@moq/hang`", link: "/lib/js/@moq/hang" },🤖 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 `@doc/.vitepress/config.ts` at line 194, The sidebar entry for the "`@moq/hang`" leaf contains a trailing slash in its link ("/lib/js/@moq/hang/") which breaks consistency with other leaf entries; update the link value in the sidebar array entry that has text "`@moq/hang`" to remove the trailing slash so it becomes "/lib/js/@moq/hang", keeping the rest of the object unchanged.
🤖 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 `@doc/.vitepress/config.ts`:
- Line 194: The sidebar entry for the "`@moq/hang`" leaf contains a trailing slash
in its link ("/lib/js/@moq/hang/") which breaks consistency with other leaf
entries; update the link value in the sidebar array entry that has text
"`@moq/hang`" to remove the trailing slash so it becomes "/lib/js/@moq/hang",
keeping the rest of the object unchanged.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: ffc7d01d-72a0-49e5-bcdd-3455f487de90
📒 Files selected for processing (4)
doc/.vitepress/config.tsdoc/lib/js/@moq/hang/index.mddoc/lib/js/@moq/hang/publish.mddoc/lib/js/@moq/hang/watch.md
💤 Files with no reviewable changes (2)
- doc/lib/js/@moq/hang/watch.md
- doc/lib/js/@moq/hang/publish.md
Now that @moq/hang is a leaf entry, match the slash-free style of the other package links. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
|
Addressed the trailing-slash nitpick on the (Written by Claude) |
Summary
The
@moq/hangdocs carriedwatch.mdandpublish.mdsubsections that duplicated material the dedicated@moq/watchand@moq/publishpages already cover (more thoroughly). Watching/publishing belongs under those packages, not under the core media library.This PR removes the duplication:
doc/lib/js/@moq/hang/watch.mdanddoc/lib/js/@moq/hang/publish.md.@moq/hang→ Watch/Publish entries in the VitePress sidebar into a single@moq/hanglink./lib/js/@moq/watchand/lib/js/@moq/publishpages.No dangling references to the removed pages remain (
grepfor@moq/hang/watch/@moq/hang/publishacrossdoc/is empty).Note for reviewers
The old
hang/publish.mdhad a small Authentication section (JWT-in-URL example linking to/bin/relay/auth) that the dedicated@moq/publishpage doesn't currently have. I left it out to keep this a clean removal. Happy to port that snippet into@moq/publish.mdin a follow-up if wanted.🤖 Generated with Claude Code
(Written by Claude)