Proposal
Would you be open to publishing a generated Go API reference on the existing TySug site? I have a draft implementation ready that:
- generates searchable reference pages from all six Go packages using Sourcey 3.6.5 and its real Go adapter;
- publishes the static output under the project-owned https://tysug.net/docs/reference/ path;
- links the reference from the README;
- pins the Sourcey version, pnpm lockfile, and Node 20+ requirement so the output is reproducible; and
- leaves the Go runtime and public API unchanged.
The generated pages include source links, exported functions and types, search data, a sitemap, and LLM-friendly text exports. The build also applies a small deterministic base-path correction because Sourcey 3.6.5 currently emits root-relative navigation links even when a subpath is configured.
I will open the implementation as a draft PR referencing this issue so the exact generated output and maintenance cost are easy to review.
Disclosure: this proposal was motivated by Sourcey’s upstream documentation bounty. I am proposing it as a maintained TySug documentation feature, not as an unrelated demo deployment.
Proposal
Would you be open to publishing a generated Go API reference on the existing TySug site? I have a draft implementation ready that:
The generated pages include source links, exported functions and types, search data, a sitemap, and LLM-friendly text exports. The build also applies a small deterministic base-path correction because Sourcey 3.6.5 currently emits root-relative navigation links even when a subpath is configured.
I will open the implementation as a draft PR referencing this issue so the exact generated output and maintenance cost are easy to review.
Disclosure: this proposal was motivated by Sourcey’s upstream documentation bounty. I am proposing it as a maintained TySug documentation feature, not as an unrelated demo deployment.