Skip to content

quest(future): restore the Go docs' vanity paths after the mirrors republish - #3851

Merged
kixelated merged 1 commit into
mainfrom
quest/m1/go-vanity-docs
Sep 21, 2026
Merged

kixelated merged 1 commit into
mainfrom
quest/m1/go-vanity-docs

Conversation

@kixelated

@kixelated kixelated commented Sep 21, 2026 •

Copy link
Copy Markdown
Collaborator

Problem

#3847 swapped the badge, import, and API reference in doc/lib/go/index.md to github.com/moq-dev/moq-go because pkg.go.dev/moq.dev/moq 404s. The vanity path itself works (moq.dev/moq?go-get=1 serves the go-import tag, the proxy lists versions). The gap is release ordering: the rename to module moq.dev/moq (#2957) reached main on 2026-09-20 via the dev merge (#3793), three days after the last moq-ffi-v0.3.19 tag, so every mirror tag still declares the github.com/... paths and go get moq.dev/moq fails on the path mismatch. release-go.yml already defers on every main push for exactly this reason, waiting on the moq-ffi-v0.4.0 tag from #3730. Without a quest the revert gets lost.

Approach

Add quest/future/go-vanity-docs.md holding the condition as a plain-text Required bullet: when it clears, revert #3847 and verify both pkg.go.dev pages return 200.

Placement: #3855 renamed the quest tree after this PR opened. quest/future/README.md is where a quest gated on the outside world (an upstream release) waits with its condition as a plain-text Required bullet, and this is a docs revert, not a published API break, so it does not belong under dev. It ranks first in future because it is the only entry with a concrete near-term trigger and is XS. Related now points at /quest/dev/release.md.

Impact

  • None. Quest file and future index only.

Alternatives

  • quest/main: rejected, main holds work landing now and this cannot start until the mirrors republish.
  • Requiring /quest/dev/release.md instead of the plain-text bullet: rejected, the Go mirror republishes on the next moq-ffi-v* tag, which release-plz can cut before the release moq.pro adopts.

Follow-ups

  • None.

🤖 Generated with Claude Code

@kixelated
kixelated marked this pull request as ready for review September 21, 2026 16:29
@coderabbitai

coderabbitai Bot commented Sep 21, 2026 •

Copy link
Copy Markdown
Contributor

Review Change StackReview Change Stack

Understand this PR’s impact

Explore downstream dependencies and potential security impact with Blast Radius.

View blast radius →

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Advanced

Run ID: 11716a80-84ab-44d7-bd5e-0c137954ac30

📥 Commits

Reviewing files that changed from the base of the PR and between 9a535eb and 9cb65ae.

📒 Files selected for processing (2)
  • quest/future/README.md
  • quest/future/go-vanity-docs.md

Included review availability: Your plan provides up to 4 included reviews per hour; 1 remains after this review.


Walkthrough

Adds a future quest link for “Go vanity docs.” The new quest document records the required mirror module declaration, the planned revert of PR #3847, and verification checks for the two pkg.go.dev vanity URLs.

Priority: ⬇️ Low

Merge Risk: ⚪ Minimal · up to 9cb65

The PR adds deferred quest documentation only and is mergeable.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
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.
Title check ✅ Passed The title clearly identifies a future quest to restore the Go documentation vanity paths after the mirror release. This matches the main change and its release condition.
Description check ✅ Passed The description directly explains the problem, release condition, proposed quest, placement, and impact. It is related to the changeset.
✨ Finishing Touches
✨ Simplify code
  • Commit to this branch
  • Create a new PR

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.

@moq-bot

moq-bot Bot commented Sep 21, 2026

Copy link
Copy Markdown
Contributor

No issues found.
Verdict: approve
(Written by Muse Spark)

New%20session%20-%202026-09-21T16%3A29%3A25.791Z
opencode session  |  github run

@kixelated

Copy link
Copy Markdown
Collaborator Author

MERGE

Positive improvement: yes. #3847 was a temporary docs workaround while mirrors still declare the old github.com/... module paths; parking a gated quest to revert once moq-ffi-v0.4.0 republishes moq.dev/moq keeps the follow-up from getting lost.

Worth the complexity: yes — quest file plus an m1 index line, no code. The Required bullet names the real condition (mirror declares module moq.dev/moq) instead of a vague "after the next release."

Different approach: doing the revert inside the release PR itself would also work, but a quest matches how this repo tracks deferred cleanup, and the write-up of why pkg.go.dev 404s is useful on its own.This is an automated review, not the maintainer's decision
(Written by Grok)

…publish

Gated on the next Go mirror release, so it waits under quest/future per
quest/README.md.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
@kixelated
kixelated force-pushed the quest/m1/go-vanity-docs branch from 9a535eb to 9cb65ae Compare September 21, 2026 20:23
@kixelated kixelated changed the title quest(m1): restore the Go docs' vanity paths after the mirrors republish quest(future): restore the Go docs' vanity paths after the mirrors republish Sep 21, 2026
@kixelated
kixelated enabled auto-merge (squash) September 21, 2026 20:24
@kixelated
kixelated merged commit 7503555 into main Sep 21, 2026
4 checks passed
@kixelated
kixelated deleted the quest/m1/go-vanity-docs branch September 21, 2026 20:29
@moq-bot

moq-bot Bot commented Sep 21, 2026

Copy link
Copy Markdown
Contributor

No issues found.
Verdict: approve
(Written by Muse Spark)

New%20session%20-%202026-09-21T20%3A24%3A12.952Z
opencode session  |  github run

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