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.

Sign up for GitHub

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

Jump to bottom

Re-work on Overview pages #106

Open
dandhlee opened this issue Aug 23, 2021 · 2 comments
Open

Re-work on Overview pages #106

dandhlee opened this issue Aug 23, 2021 · 2 comments
Assignees
@dandhlee
Labels
priority: p1 Important issue which blocks shipping the next release. Will be fixed prior to next release. type: feature request ‘Nice-to-have’ improvement, new feature or different behavior or design.

Comments

@dandhlee
Copy link
Collaborator

dandhlee commented Aug 23, 2021 •
edited

Googlers see b/200623336.

There's a lot of Sphinx-specific formatting that's done on reference.md files that could be incorporated into the Overview pages for a better Overview page. This can be used as an upgraded entry point for each client library into the different parts of the product.
@dandhlee dandhlee added type: feature request ‘Nice-to-have’ improvement, new feature or different behavior or design. priority: p2 Moderately-important priority. Fix may not be included in next release. labels Aug 23, 2021
@dandhlee dandhlee self-assigned this Aug 23, 2021
@dandhlee dandhlee changed the title Parse reference.md pages into Overview pages Re-work on Overview pages Sep 21, 2021
@dandhlee
Copy link
Collaborator Author

Besides reference.md, we could add an about group as suggested from an internal review. The proposed group will contain the overview and changelog and other information, and operations can contain other information users would like.

I like the about group containing some of the meta-info such as changelog and Overview and other pages, helping the user focus on only the relevant information.

This was referenced Nov 16, 2021
Closed
Closed
Closed
@dandhlee dandhlee added priority: p1 Important issue which blocks shipping the next release. Will be fixed prior to next release. and removed priority: p2 Moderately-important priority. Fix may not be included in next release. labels Nov 17, 2021
@dandhlee
Copy link
Collaborator Author

Raising to P1 to address this ASAP.

@dandhlee dandhlee mentioned this issue Nov 17, 2021
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@dandhlee dandhlee

Labels
priority: p1 Important issue which blocks shipping the next release. Will be fixed prior to next release. type: feature request ‘Nice-to-have’ improvement, new feature or different behavior or design.
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@dandhlee