Declutter README and Doxygen landing pages #10157
Labels
type: docs
Improvement to the documentation for an API.
type: feature request
‘Nice-to-have’ improvement, new feature or different behavior or design.
The README and Doxygen landing pages are getting cluttered. I think we should reduce the amount of data in the main page and refactor it to other pages.
Now that I have done the work for a few libraries, it is clearer how I should break this down.
README.md#building-and-installing
too.@par Example: Quickstart
to## Quickstart
## Next Steps
at the end of the quickstart-
[github-link]
[github-readme]
and[github-quickstart]
links to this section- clean the up too
@page
, still in the samemain.dox
file.* Link this mate from
## Next Steps
## Override the authentication configuration
section to a@page
, still in the samemain.dox
file, and reference it from the## Next Steps
## Override the default endpoint
section## Error Handling
page and just reference the common page for that purpose## Environment Variables
section to a page in the samemain.dox
file.For example, the README for something like KMS should read:
Cloud Key Management Service (KMS) API C++ Client Library
This directory contains an idiomatic C++ client library for
Cloud Key Management Service (KMS), a service that manages
keys and performs cryptographic operations in a central cloud service, for
direct use by other cloud resources and applications.
While this library is GA, please note that the Google Cloud C++ client libraries do not follow
Semantic Versioning.
Quickstart
The quickstart/ directory contains a minimal environment
to get started using this client library in a larger project. The following
"Hello World" program is used in this quickstart, and should give you a taste of
this library.
Next Steps
/usr/local
,/opt
, or a similar location consult thepackaging guide. Package maintainers may find this useful too.
CONTRIBUTING.md
for details on how to contribute to this project.LICENSE
for details.Likewise, the Doxygen landing page should move the sections covering environment variables, how to perform error handling, how to override defaults to separate sections, and just link them from the landing page.
The text was updated successfully, but these errors were encountered: