Skip to content

docs: add Sourcey OpenAPI reference - #191

Open
lxx197818 wants to merge 1 commit into
CETEN-OpenBar:mainfrom
lxx197818:codex/sourcey-openapi-docs
Open

docs: add Sourcey OpenAPI reference#191
lxx197818 wants to merge 1 commit into
CETEN-OpenBar:mainfrom
lxx197818:codex/sourcey-openapi-docs

Conversation

@lxx197818

Copy link
Copy Markdown

Summary

Adds a static Sourcey-generated OpenAPI reference under docs/sourcey/ for the repository's checked-in bar.openapi.yml specification.

What is included

  • docs/sourcey/index.html and docs/sourcey/api.html generated by Sourcey
  • search-index.json, llms.txt, and llms-full.txt for search/LLM-readable reference use
  • A short docs/sourcey/README.md with the generation command and scope

Validation

  • Generated from bar.openapi.yml
  • Sourcey build completed successfully
  • The generated reference covers 72 OpenAPI path items and 103 operations

Command used:

sourcey build ./bar.openapi.yml -o ./docs/sourcey --quiet

@RemiF1908

Copy link
Copy Markdown
Contributor

Hi, who are you ?

@lxx197818

lxx197818 commented Jul 6, 2026

Copy link
Copy Markdown
Author

Hi! I’m a contributor working on improving API documentation for projects that already publish an OpenAPI spec. I noticed this repo has bar.openapi.yml, so I generated a static Sourcey reference under docs/sourcey/ as a concrete proposal.

If this isn’t useful for your docs direction, no worries — I can close it. If you’d like it, I’m happy to adjust the structure, reduce generated output, or move it to a different docs path.

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