Skip to content
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

feat(godocfx): add friendly api name to yaml #5949

Closed
dansaadati opened this issue Apr 27, 2022 · 2 comments · Fixed by #6447
Closed

feat(godocfx): add friendly api name to yaml #5949

dansaadati opened this issue Apr 27, 2022 · 2 comments · Fixed by #6447
Assignees
Labels
type: docs Improvement to the documentation for an API.

Comments

@dansaadati
Copy link

doc-templates will display the friendly api name in the <h1>(pr) and first paragraph summary (pr) of generated pages. godocfx should include a friendlyApiName as an item key in the yaml which describes the simplified name of the Go library along with its API version. For example, the Cloud Vision apiv1p1beta1 library should set the friendly api name to be something like "Cloud Vision V1p1beta1 API"

This change will help discern documentation across API versions.

@dansaadati dansaadati added triage me I really want to be triaged. type: docs Improvement to the documentation for an API. and removed triage me I really want to be triaged. labels Apr 27, 2022
@codyoss
Copy link
Member

codyoss commented Jun 29, 2022

@dansaadati Is this something that is still going to have action taken? I wonder if this is best to track in an internal bug instead of here?

@dansaadati
Copy link
Author

Yes, assigning to @tbpg . We'd like this added to improve SEO for Go pages.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: docs Improvement to the documentation for an API.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants