docs: add generated Go API reference - #25
Open
q10283245 wants to merge 3 commits into
Open
Conversation
Up to standards ✅🟢 Issues
|
| Metric | Results |
|---|---|
| Complexity | 0 |
| Duplication | 0 |
NEW Get contextual insights on your PRs based on Codacy's metrics, along with PR and Jira context, without leaving GitHub. Enable AI reviewer
TIP This summary will be updated as you push new changes.
q10283245
marked this pull request as ready for review
July 13, 2026 13:31
Author
|
Quick maintainer note: the branch is still mergeable, Codacy reports 0 issues, and the generated reference reproduces from the pinned upstream commit. If committing the generated static pages is too heavy, I can reduce the PR to the Sourcey config/build wiring or adjust the published path. Would you prefer the full generated reference or a lighter config-only version? I won’t ping again; any direction is welcome. |
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.
Closes #24.
What changed
Why
TySug currently has package-specific README files and a GoDoc badge, but no searchable project-owned API reference covering the library and web-service packages together. Keeping the generated files below the existing GitHub Pages root makes the reference available on tysug.net without changing the Pages setup or runtime code.
Implementation notes
The reference was generated from upstream commit 708d091. From docs/sourcey, run pnpm install --frozen-lockfile followed by pnpm build.
Sourcey 3.6.5 currently applies baseUrl to canonical URLs and search results but emits its sidebar navigation as root-relative links. The small post-build script only prefixes those generated navigation links with /docs/reference/ and fails if no links are rewritten. This keeps navigation working when the files are served from TySug’s existing site subpath.
Impact
There are no changes to Go behavior or public APIs. On merge, the committed static files become available through the repository’s existing Pages deployment; future reference updates are deterministic from the pinned config and lockfile.
Validation
Disclosure: this work was motivated by Sourcey’s upstream documentation bounty. The PR is intentionally a draft so the generated output and ongoing maintenance trade-off can be reviewed before adoption.