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 two levels of nesting to TOC #2972

Merged
merged 1 commit into from Oct 6, 2020
Merged

feat(godocfx): add two levels of nesting to TOC #2972

merged 1 commit into from Oct 6, 2020

Conversation

@tbpg
Copy link
Collaborator

@tbpg tbpg commented Oct 6, 2020

The TOC is a bit unruly with every package in a single list. So, I added a couple levels of nesting: one for the module and one for the first part after the module. In other words, I split package names into mod/mid/suffix and nest shared mod and mid values. If there would only be one element in the nested list, it isn't nested. This is like a trie with only two levels.

The result looks like this:

- uid: cloud.google.com/go/bigquery
  name: cloud.google.com/go/bigquery
  items:
  - name: README
    href: README.md
  - name: connection
    items:
    - uid: cloud.google.com/go/bigquery/connection/apiv1
      name: apiv1
    - uid: cloud.google.com/go/bigquery/connection/apiv1beta1
      name: apiv1beta1
  - uid: cloud.google.com/go/bigquery/datatransfer/apiv1
    name: datatransfer/apiv1
@tbpg tbpg requested a review from codyoss Oct 6, 2020
@tbpg tbpg requested a review from googleapis/yoshi-go-admins as a code owner Oct 6, 2020
@google-cla google-cla bot added the cla: yes label Oct 6, 2020
@codyoss
codyoss approved these changes Oct 6, 2020
Copy link
Member

@codyoss codyoss left a comment

Good idea! LGTM

@tbpg tbpg merged commit 3a49b2d into master Oct 6, 2020
3 checks passed
3 checks passed
@google-cla
cla/google All necessary CLAs are signed
@conventional-commit-lint-gcf
conventionalcommits.org
Details
@kokoro-team
kokoro Kokoro CI build successful
Details
@tbpg tbpg deleted the toc branch Oct 6, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Linked issues

Successfully merging this pull request may close these issues.

None yet

2 participants