Repository navigation
docs: fix HexDocs source links; add a docs-only publish workflow - #14
Merged
Merged
Conversation
"View source" linked blob/<tag>/lib/..., missing the package's directory in the monorepo, so every link 404'd. source_url_pattern adds it. Actions → Docs republishes a package's HexDocs from main under its current version, so doc fixes like this one don't need a release. Claude-Session: https://claude.ai/code/session_012aEMFtJKJsMz1vGtbSijGR
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
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.
Both 1.0.0 releases published their docs: durable and durable_dashboard, changelog included. But every "View source" link is broken. They point at
blob/durable-v1.0.0/lib/durable.exand leave out the package's folder in the monorepo, so GitHub returns 404.Changes
source_url_patternin bothmix.exsfiles now includes the package folder, e.g.blob/durable-v1.0.0/durable/lib/durable.ex#L1. I checked links built locally for both packages, and they return 200 on GitHub.mix hex.publish docsfrommainunder the package's current version. Releases already publish docs, so this is only for doc fixes between releases. It doesn't run on every push tomain, becausemaincan document APIs that aren't released yet, and those would show up under the released version.actionlintpasses.After merging
Run Docs for
durable, then fordurable_dashboard, to republish 1.0.0's docs with working links.https://claude.ai/code/session_012aEMFtJKJsMz1vGtbSijGR