Using the documentation
1. Choose the product and version
Section titled “1. Choose the product and version”The version in the page header belongs to the documented product. Its API version may be different. Check it against the service you use. A guide for another release may not describe your installation.
2. Choose a guide
Section titled “2. Choose a guide”A quickstart covers the first steps, a guide solves a specific task, a tutorial walks through a complete process, and concepts explain the background. An API reference describes operations, parameters and responses. Use the changelog and migration guide when changing versions.
3. Search with filters
Section titled “3. Search with filters”Open search, enter a term such as “authentication”, and choose a product, product/API version, language or documentation type. Search uses a public index downloaded into your browser.
4. Check examples before using them
Section titled “4. Check examples before using them”Example identifiers and tokens are synthetic. The host api.example.invalid is not a production service.
Store credentials as directed by the service owner; never embed them in public JavaScript.
The API reference is for reading. Documentation grants no API permissions and does not automatically execute requests.
5. Use portable sources
Section titled “5. Use portable sources”Approved content provides Markdown and OpenAPI JSON/YAML downloads. llms.txt lists public entry points for machine reading. Downloads belong to the displayed version; check the changelog when updating.
© MiloslavHub · CC BY 4.0