Skip to content

docs: add generated Sourcey API documentation - #692

Closed
q10283245 wants to merge 2 commits into
ipld:masterfrom
q10283245:prep/sourcey-docs
Closed

docs: add generated Sourcey API documentation#692
q10283245 wants to merge 2 commits into
ipld:masterfrom
q10283245:prep/sourcey-docs

Conversation

@q10283245

Copy link
Copy Markdown

What changed

  • add a pinned Sourcey 3.6.5 configuration that generates reference pages from both the v1 and v2 Go modules
  • add concise guides for version selection and common workflows
  • add a GitHub Actions build on documentation and Go changes, with Pages deployment after changes land on master

Why

The repository currently points users to source and package docs in several places, but it does not have one searchable reference covering both module generations. The generated site keeps symbol documentation tied to the repository source while separating v1 and v2 clearly.

Validation

  • npm ci in docs/sourcey
  • npm run build in docs/sourcey
  • Sourcey generated 18 pages plus llms.txt, llms-full.txt, a search index, and sitemap
  • spot-checked generated v2 symbols including NewBlockReader, OpenReader, NewSelectiveWriter, StoreIdentityCIDs, and ReadFrom

This is a draft so maintainers can first confirm whether the proposed documentation location and Pages deployment model fit the project.

Signed-off-by: wei wang <10283245@qq.com>
Signed-off-by: wei wang <10283245@qq.com>
@q10283245
q10283245 marked this pull request as ready for review July 13, 2026 07:07
@rvagg

rvagg commented Jul 13, 2026

Copy link
Copy Markdown
Member

no spam pls

@rvagg rvagg closed this Jul 13, 2026
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.

2 participants