-
Notifications
You must be signed in to change notification settings - Fork 283
Open
Labels
documentationImprovements or additions to documentationImprovements or additions to documentation
Description
Documentation link
Missing documentation for https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/blob/6c12cd7fcd74e4fe8c8b02137ee1077daad136ac/demo/api.mustache.
Describe the problem
Every time I regenerate API docs, the api:
variable keep changing in all the generated mdx files and it's usually a long string of characters. This is very distracting for code reviews and in git history. I can't find documentation on what it actually is. I also can't find documentation for all other variables in that api.mustache template, which makes it very hard for me to customize the template.
Suggested fix
- Add documentation to explain what the
api:
variable is and how we can configure the project such that it doesn't have to change every time we regenerate the mdx files. - Add documentation to explain what each of the variables in api.mustache template.
Metadata
Metadata
Assignees
Labels
documentationImprovements or additions to documentationImprovements or additions to documentation