docs: add Sourcey-generated API site - #656
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #656 +/- ##
=======================================
Coverage 87.48% 87.48%
=======================================
Files 13 13
Lines 2102 2102
=======================================
Hits 1839 1839
Misses 175 175
Partials 88 88 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
|
Hi @fclairamb — this is ready for review. The repository checks and the documentation build are green, and the change is limited to the generated API site plus its validation and Pages workflow. I am happy to trim or split the contribution if you would prefer a smaller integration. |
|
Thanks for taking the time to put this together, but I'm going to pass on this one. ftpserverlib is a deliberately small Go library with a handful of Go dependencies, and this PR adds ~6,850 lines and a 302-package npm lockfile plus a GitHub Actions workflow with If I do want a docs site at some point, I'd rather decide on the toolchain myself. Appreciate the effort regardless. |
Add a reproducible Sourcey documentation site
Summary
ftpserverlib, pinned to commitb4c3694ee73399d8a55293d568e5100c25e4d2d4Why
The project README gives a useful overview, but consumers currently have to navigate source and GoDoc to understand the driver contract, settings, and extension points. This adds a browsable project-owned reference with pinned source links and machine-readable
llms.txtoutputs.Verification
All commands pass locally. The generated snapshot reports 92 public API concepts, 9 HTML pages (including the compatibility alias), 65 pinned source links, and 0 broken internal references.
Maintainer action after merge
If GitHub Pages has not been enabled for this repository before, select GitHub Actions as the Pages source once. The workflow then deploys
docs-sourcey/distto the repository-owned Pages site.No library runtime code or Go dependencies are changed.