Rename "API Reference" to "Add an OpenAPI specification to your documentation" #81
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
source/api_ref.html.md.erb
Outdated
| @@ -1,6 +1,6 @@ | |||
| --- | |||
| title: "API reference" | |||
| title: "Incorporate an OpenAPI spec" | |||
There was a problem hiding this comment.
How about "Add an OpenAPI specification to your documentation"?
There was a problem hiding this comment.
That's much better. Thank you. Will reword.
The term "API Reference" does not do a good job of explaining what this feature actually is: a way to incorporate an OpenAPI spec into the generated documentation.
duncanjbrown
force-pushed
the
explicit-name-for-openapi-feature
branch
from
d4958b2
to
283c683
Compare
duncanjbrown
changed the title
|
Reworded |
jonathanglassman
approved these changes
Jun 24, 2019
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.
Context
We recently used this template to document an API, and very nearly missed the useful feature which automatically generates good-looking documentation from an OpenAPI spec. It was hidden under the the term "API reference", which is not very explicit.
Changes proposed in this pull request
Change the menu item "API reference" to "Incorporate an OpenAPI spec", and change the associated page title too.
While we're here, add a link to the swagger.io
/aboutpage to help those who don't know what OpenAPI is.Guidance to review
a) agree/disagree that the existing menu item is a bit obscure
b) consider whether the replacement could be better worded