docs: improve API contribution guidelines #1137
Merged
Conversation
This file contains 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
Clarify when to update documentation, explain `uv sync --extra dev` and OpenAPI generation, and specify where generated docs are stored. Signed-off-by: Sébastien Han <[email protected]>
leseb
requested review from
ashwinb,
yanxi0830,
hardikjshah,
dltn,
raghotham,
dineshyv,
vladimirivic,
sixianyi0721,
ehhuang and
terrytangyuan
as code owners
facebook-github-bot
added
the
CLA Signed
booxter
approved these changes
Feb 18, 2025
yanxi0830
approved these changes
Feb 18, 2025
ashwinb
reviewed
Feb 20, 2025
| @@ -139,6 +139,16 @@ $ make html | |||
| $ uv run sphinx-autobuild source build/html | |||
| ``` | |||
|
|
|||
| ### Update API Documentation | |||
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 does this PR do?
Clarify when to update documentation, explain
uv sync --extra devand OpenAPI generation, and specify where generated docs are stored.Signed-off-by: Sébastien Han [email protected]