Add searchable API documentation site - #82
Open
epistemedeus wants to merge 2 commits into
Open
Conversation
Signed-off-by: epistemedeus <epistemedeus@gmail.com>
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
/docs/.490705b.llms.txt, and a sitemap.sourcey/.Motivation
This provides a concrete first version of the documentation site requested in gopherjs/gopherjs#1143. It centralizes the public Go API in a project-owned, searchable home while linking users to the existing install guide, compatibility notes, supported-package notes, playground, and pkg.go.dev.
Live review
The generated site is available at https://samedaydesk.com/docs-lab/gopherjs/ while this pull request is reviewed. SameDayDesk owns and maintains that durable mirror as a public Docs Lab case study; it is not affiliated with GopherJS and is not represented as the project's canonical documentation. The project-owned
/docs/deployment in this pull request remains the intended canonical destination after merge.Build
From
sourcey/:The committed
godoc.jsonsnapshot means the Pages build does not need a Go toolchain. Generated output is committed so the repository's existing GitHub Pages deployment can serve it without a new CI dependency.Verification
npm ci --ignore-scriptscompleted with zero reported vulnerabilities.npm run buildproduced 19 Sourcey pages and 20 HTML files.git diff --checkpasses.The small postbuild step is documented and deterministic. It works around Sourcey 3.6.5's generated API landing-link mismatch, corrects the local introduction edit link, and normalizes public punctuation.