-
Notifications
You must be signed in to change notification settings - Fork 11
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: add new Java overview template #439
Conversation
testdata/goldens/java/overview.html
Outdated
<h2 id="packages"> | ||
</h2> | ||
<h2><a class="xref" href="com.google.cloud.speech.v1.html">com.google.cloud.speech.v1</a></h2> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
com.google.cloud.speech.v1
is a package, so do we know what the above and empty <h2 id="packages">
is meant to be used for?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
So <h2 id="packages">
is the title for the section, but is hidden when the page type is an namespace/overview (https://github.com/googleapis/doc-pipeline/blob/main/third_party/docfx/templates/devsite/ManagedReference.common.js#L265), which is why you don't see it when you look at https://cloud.google.com/java/docs/reference/google-cloud-apikeys/latest/overview for example.
If it was not hidden, it'd be akin to the Classes
title like this: https://cloud.google.com/java/docs/reference/google-cloud-apikeys/latest/com.google.api.apikeys.v2#classes
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ah. Understood. Thank you.
Messed up rebasing this PR - will open a new one. |
Fix for #436
parent bug: b/278903399
Corresponds to [R9] Confusing ‘On This Page’ Indentation on go/cloud-java-rad-refactor and slide 20 on go/cloud-java-rad-visual-review.
For example on: https://cloud.google.com/java/docs/reference/google-cloud-apikeys/latest/overview
APIKeysClient is outdented even though it is a child of com.google.api.apikeys.v2.
This will be a two-part fix, with this being the template change, and googleapis/java-docfx-doclet#178 being the doclet change