docs: publish Sourcey API reference on GitHub Pages#569
Open
IvanchitorJR wants to merge 2 commits into
Open
Conversation
a3dd729 to
5a74514
Compare
Author
|
CI note for maintainers: the current failure is the existing WebAssembly test timing out ( |
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.
Why
This repository already owns a GitHub Pages deployment, but it currently publishes only
coverage.html; the Pages root returns 404. The README links individual symbols to pkg.go.dev, but there is no project-owned, searchable API home or LLM context export.What changed
godocadapter.github.com/coder/websocketandgithub.com/coder/websocket/wsjson.coverage.htmlandcoverage.svg./websocket/GitHub Pages base path.Verification
pnpm install --frozen-lockfilepnpm docs:build(3 HTML pages; root API, duplicate landing entry, andwsjson; plus search, sitemap,llms.txt, andllms-full.txt)go test ./...go vet ./...GOOS=js GOARCH=wasmpackage compilationAccept,Dial,Conn,Read, andWrite, with no unexpanded documentation directives.A review-only mirror of the exact generated output is live at https://coder-websocket-sourcey.ivandejesus1806.chatgpt.site/. After merge, the existing workflow publishes the project-owned home at https://coder.github.io/websocket/.
No runtime code or public API changes.