-
Notifications
You must be signed in to change notification settings - Fork 159
Add API docs contribution guidance under extend/contribute #2229
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from 13 commits
Commits
Show all changes
19 commits
Select commit
Hold shift + click to select a range
b838633
Add API docs contribution guidance under extend/contribute
leemthompo 37ab7b4
typos, links
leemthompo e9bb158
fix up me anchor
leemthompo c6a4e7f
🔗
leemthompo b28203c
simplify dir name
leemthompo 6b7b7bb
what
leemthompo 4737397
link from contribution overview page
leemthompo dcf1aca
Improve nav title
leemthompo 420f95c
typo
leemthompo 0925813
typomg
leemthompo 234d002
tweak toc descriptions
leemthompo 37e2d01
tweaks
leemthompo a9f2279
Merge branch 'main' into leemthompo/api-docs-contrib
georgewallace ae67103
Updates to checklist and worflows pages per Fab's review
leemthompo 10c0fb2
Updates per review:
leemthompo 4d25041
Merge branch 'main' into leemthompo/api-docs-contrib
leemthompo 1f15927
Fixing links: Chapter 90000000
leemthompo 47aee56
Update diagram
leemthompo a201cbc
Merge branch 'main' into leemthompo/api-docs-contrib
leemthompo File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,35 @@ | ||
--- | ||
navigation_title: Checklist | ||
--- | ||
|
||
# API docs checklist | ||
|
||
Use this checklist to verify the quality, completeness, and consistency of your API docs contributions. | ||
|
||
## Content quality and completeness | ||
|
||
|
||
- ☑️ Write clear [summaries](./guidelines.md#write-summaries) (30 characters max, start with a verb) | ||
leemthompo marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
- ☑️ Write detailed [descriptions](./guidelines.md#write-descriptions) for operations, parameters, properties, tags etc. | ||
- ☑️ Document all [path parameters](./guidelines.md#document-path-parameters) with constraints and formats | ||
- ☑️ Provide descriptions for non-obvious [enum values](./guidelines.md#document-enum-values) | ||
- ☑️ Specify [default values](./guidelines.md#set-default-values) for optional parameters | ||
- ☑️ Include realistic [examples](./guidelines.md#add-examples) with helpful descriptions | ||
- ☑️ Add [links](./guidelines.md#add-links) to related operations and documentation | ||
|
||
## Structure, organization, and metadata | ||
leemthompo marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
- ☑️ Include required [OpenAPI document info](./organize-annotate.md#add-open-api-document-info) | ||
- ☑️ Include [OpenAPI specification version](./organize-annotate.md#add-openapi-specification-version) | ||
- ☑️ Define unique [operation identifiers](./organize-annotate.md#add-operation-identifiers) using camelCase | ||
- ☑️ Use consistent [tags](./organize-annotate.md#group-apis-with-tags) to group related operations | ||
- ☑️ Document [API lifecycle status](./organize-annotate.md#specify-api-lifecycle-status) (availability, stability, version information) | ||
- ☑️ Mark deprecated APIs and properties with appropriate notices | ||
- ☑️ Document [required permissions](./organize-annotate.md#document-required-permissions) for each operation | ||
|
||
## Quality assurance | ||
|
||
- ☑️ Preview your changes locally before submitting | ||
leemthompo marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
- ☑️ [Lint your API docs](guidelines.md#lint-your-api-docs) to identify and fix issues | ||
- ☑️ Check all links to ensure they work correctly | ||
- ☑️ Ensure examples are realistic and error-free | ||
- ☑️ Validate that your OpenAPI document is well-formed | ||
theletterf marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
Oops, something went wrong.
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.