redhat-documentation / asciidoc-markup-conventions

How to use AsciiDoc mark-up to properly style elements in Red Hat documentation
https://access.redhat.com/documentation/
17 stars 16 forks source link

Add context description to clarify purpose of this resource #38

Open yetanothertw opened 3 years ago

yetanothertw commented 3 years ago

This quick reference would benefit from a description that explains its purpose, for example that it describes the technical implementation of various style elements.

For information about stylistic choices, see the IBM Style Guide and the Red Hat supplementary style guide for product documentation (https://redhat-documentation.github.io/supplementary-style-guide/#user-replaced-values)

For information about modular documentation guidelines, see the Modular Documentation Reference Guide (https://redhat-documentation.github.io/modular-docs/).