docs: publish Sourcey-generated Go reference#105
Open
zdfgu113 wants to merge 1 commit into
Open
Conversation
Author
|
A public preview of the proposed Sourcey reference is available at https://zdfgu113.github.io/txeh/reference/. I also ran a read-only validation against the PR checkout: Sourcey 3.6.5 markers were present on 10 pages, the godoc snapshot contained 82 public API items, and browser checks covered guide navigation, the Go API route, search, and a search-result deep link. The PR remains mergeable and does not commit generated HTML. |
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.
Summary
/reference/Rationale
The current guides remain the best entry point for users, while the generated reference gives maintainers and consumers a searchable view of exported packages and symbols that stays synchronized with the source. No generated HTML is committed.
Sourcey is pinned to
3.6.5, and the build runs from the same checkout that Pages deploys. The small compatibility copy keeps Sourcey's Go API tab route working with its default flat HTML output.Validation
npx --yes sourcey@3.6.5 build --output site/reference/reference/git diff --checkgo test ./...still has the repository's existing Windows-only failures where DNS-flush tests stub the Unixtruecommand; this change does not modify Go code.