Skip to content

docs: move hang watch/publish guides into their own packages - #1613

Merged
kixelated merged 2 commits into
mainfrom
claude/distracted-haslett-9eceb0
Jun 3, 2026
Merged

docs: move hang watch/publish guides into their own packages#1613
kixelated merged 2 commits into
mainfrom
claude/distracted-haslett-9eceb0

Conversation

@kixelated

Copy link
Copy Markdown
Collaborator

Summary

The @moq/hang docs carried watch.md and publish.md subsections that duplicated material the dedicated @moq/watch and @moq/publish pages already cover (more thoroughly). Watching/publishing belongs under those packages, not under the core media library.

This PR removes the duplication:

  • Delete doc/lib/js/@moq/hang/watch.md and doc/lib/js/@moq/hang/publish.md.
  • Collapse the nested @moq/hang → Watch/Publish entries in the VitePress sidebar into a single @moq/hang link.
  • Repoint hang's "Next Steps" links at the dedicated /lib/js/@moq/watch and /lib/js/@moq/publish pages.

No dangling references to the removed pages remain (grep for @moq/hang/watch / @moq/hang/publish across doc/ is empty).

Note for reviewers

The old hang/publish.md had a small Authentication section (JWT-in-URL example linking to /bin/relay/auth) that the dedicated @moq/publish page doesn't currently have. I left it out to keep this a clean removal. Happy to port that snippet into @moq/publish.md in a follow-up if wanted.

🤖 Generated with Claude Code

(Written by Claude)

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>
@coderabbitai

coderabbitai Bot commented Jun 3, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: a5c26c09-6a9e-431b-91cc-e53a8007695b

📥 Commits

Reviewing files that changed from the base of the PR and between 4da543e and f8ae53f.

📒 Files selected for processing (1)
  • doc/.vitepress/config.ts
🚧 Files skipped from review as they are similar to previous changes (1)
  • doc/.vitepress/config.ts

Walkthrough

This PR reorganizes the documentation structure for the @moq project by elevating @moq/watch and @moq/publish from nested sub-items under @moq/hang to independent top-level package entries in the VitePress sidebar navigation. The VitePress configuration is updated to reflect this flatter structure, and the internal documentation links in the hang package index are redirected to point to the new standalone package routes instead of the previous nested paths.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately describes the main change: moving watch/publish documentation from @moq/hang into their own dedicated package pages.
Description check ✅ Passed The description clearly explains the rationale, changes made, and includes helpful context for reviewers about deferred content (Authentication section).
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
✨ Simplify code
  • Create PR with simplified code
  • Commit simplified code in branch claude/distracted-haslett-9eceb0

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.

❤️ Share

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

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

🧹 Nitpick comments (1)
doc/.vitepress/config.ts (1)

194-194: ⚡ Quick win

Remove trailing slash for consistency.

The @moq/hang link 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/hang no 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

📥 Commits

Reviewing files that changed from the base of the PR and between e9c6aeb and 4da543e.

📒 Files selected for processing (4)
  • doc/.vitepress/config.ts
  • doc/lib/js/@moq/hang/index.md
  • doc/lib/js/@moq/hang/publish.md
  • doc/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>
@kixelated

Copy link
Copy Markdown
Collaborator Author

Addressed the trailing-slash nitpick on the @moq/hang sidebar link in doc/.vitepress/config.ts — now slash-free to match the other leaf entries.

(Written by Claude)

@kixelated
kixelated enabled auto-merge (squash) June 3, 2026 19:52
@kixelated
kixelated merged commit e7f53c0 into main Jun 3, 2026
1 check passed
@kixelated
kixelated deleted the claude/distracted-haslett-9eceb0 branch June 3, 2026 19:59
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.

1 participant