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

docs: add "help" section with product neutral guides #8075

Open
bshaffer opened this issue Feb 5, 2025 · 1 comment
Open

docs: add "help" section with product neutral guides #8075

bshaffer opened this issue Feb 5, 2025 · 1 comment

Comments

@bshaffer
Copy link
Contributor

bshaffer commented Feb 5, 2025

Manually sort the Table of Contents in the reference docs so that the Core libraries such as GAX and Auth and Common Protos are at the top

NOTE: The docs generation pipeline does not support manually sorting certain packages to the top. This may be possible with manually prefixing the ID to come first (e.g. aaa_google_gax)

https://cloud.google.com/php/docs/reference/

This is similar to how .NET does it.

Also consider adding a "Client library help" section. This would collect the following docs:

And in the future this would contain others such as TROUBLESHOOTING

@bshaffer
Copy link
Contributor Author

"help" was added in #8077, which can be seen here

We should also add gRPC and Getting Started

@bshaffer bshaffer changed the title docs: put "GAX" and "Auth" at the top of reference documentation, add "help" section docs: add "help" section with product neutral guides Feb 19, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant