docs: add Sourcey OpenAPI reference - #191
Open
lxx197818 wants to merge 1 commit into
Open
Conversation
Contributor
|
Hi, who are you ? |
Author
|
Hi! I’m a contributor working on improving API documentation for projects that already publish an OpenAPI spec. I noticed this repo has 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. |
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.
Summary
Adds a static Sourcey-generated OpenAPI reference under
docs/sourcey/for the repository's checked-inbar.openapi.ymlspecification.What is included
docs/sourcey/index.htmlanddocs/sourcey/api.htmlgenerated by Sourceysearch-index.json,llms.txt, andllms-full.txtfor search/LLM-readable reference usedocs/sourcey/README.mdwith the generation command and scopeValidation
bar.openapi.ymlCommand used: