Skip to content

docs: add generated Go API reference - #25

Open
q10283245 wants to merge 3 commits into
Dynom:masterfrom
q10283245:agent/sourcey-go-api-reference
Open

docs: add generated Go API reference#25
q10283245 wants to merge 3 commits into
Dynom:masterfrom
q10283245:agent/sourcey-go-api-reference

Conversation

@q10283245

Copy link
Copy Markdown

Closes #24.

What changed

  • adds a Sourcey 3.6.5 configuration backed by the real Go source adapter;
  • generates static reference pages for all six Go packages under docs/reference;
  • adds source links, search data, sitemap and LLM-friendly text exports;
  • links the project-owned https://tysug.net/docs/reference/ location from the README; and
  • pins the Node requirement, package-manager version, dependencies and lockfile.

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

  • go test ./...
  • clean Sourcey rebuild followed by git diff --exit-code
  • local HTTP checks returned 200 for all seven pages, CSS, JavaScript, search index, sitemap and text exports
  • checked generated output for unprefixed internal navigation links and local paths

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.

@codacy-production

codacy-production Bot commented Jul 13, 2026

Copy link
Copy Markdown

Up to standards ✅

🟢 Issues 0 issues

Results:
0 new issues

View in Codacy

🟢 Metrics 0 complexity · 0 duplication

Metric Results
Complexity 0
Duplication 0

View in Codacy

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
q10283245 marked this pull request as ready for review July 13, 2026 13:31
@q10283245

Copy link
Copy Markdown
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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: add a Sourcey-generated Go API reference

1 participant