Repository navigation
docs: add a Sourcey configuration for a generated API reference - #1996
Open
ASporeTeam wants to merge 2 commits into
Open
ASporeTeam wants to merge 2 commits into
ASporeTeam wants to merge 2 commits into
Conversation
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.
What this adds
A Sourcey configuration that builds a static, searchable API
reference for Testify's five public packages (
assert,require,mock,suite,http) straightfrom this repository's source.
docs/sourcey/sourcey.config.ts— the configuration (godoc adapter, live extraction with acommitted-snapshot fallback).
docs/sourcey/README.md— how to build it, what it covers, and why it is useful.Nothing is pre-generated: the reference is built from the tree, so it can be regenerated for any
commit and always matches the code.
Why
Testify's own documentation is one
README.mdplus one package comment per package; there is noper-symbol reference in this repository, and the reference most readers use (
pkg.go.dev) isauto-generated and reports no coverage. Building one from source makes two things measurable:
Example…functions, allattached to the five
…AssertionFunctypes inassertandrequire.mock,suiteandhttphave none.
That second number is the interesting one: it shows exactly which entry points a new user cannot
find an example for.
A published instance
An instance of this configuration, built from the pinned commit
87a7b9d57689f6579db2da795ab8deeab29cb724, is live at https://testify.anonymux.org/. It isoffered as a reference implementation and as an opportunity to review the configuration — if you
would rather host it on a domain you control, the same configuration and snapshot produce the same
site.
Notes for the reviewer
changes.
If you would prefer a different shape (for example a committed
godoc.jsonsnapshot, a differentpackage list, or the generated pages themselves), say so and I will adjust.