ansible/docs/docsite/rst/dev_guide/style_guide/why_use.rst

:orphan:

Why Use a Style Guide?
`````````````````````````````````

Style guides are important because they ensure consistency in the content, look, and feel of a book or a website.

Remember, a style guide is only useful if it is used, updated, and enforced.  Style Guides are useful for engineering-related documentation, sales and marketing materials, support docs, community contributions, and more.

As changes are made to the overall Ansible site design, be sure to update this style guide with those changes. Or, should other resources listed below have major revisions, consider including company information here for ease of reference.

This style guide incorporates current Ansible resources and information so that overall site and documentation consistency can be met.

.. raw:: html

   <blockquote class="note info">

   "If you don't find it in the index, look very carefully through the entire catalogue."
    ― Sears, Roebuck and Co., 1897 Sears Roebuck & Co. Catalogue

.. raw:: html

   </blockquote>
Remove more docs build errors (#45364) * orphans testing pages to avoid not-in-toctree errors * orphans various pages pending reorg * adds module_utils and special_vars to main TOC * uses a glob for scenario_guide TOC * normalize and Sentence-case headings on community pages, typos * re-orgs community TOC, adds all pages to toctree * removes scenario guides index page * adds style guide to community index * basic update to style guide * fix typo that created a new error * removes not-in-toctree from ignore errors list * leave removing files for future cleanup task 6 years ago			`:orphan:`

Added style guide (#24310) * Added style guide * Fixed index 8 years ago			`Why Use a Style Guide?`
			`````````````````````````````````

			`Style guides are important because they ensure consistency in the content, look, and feel of a book or a website.`

			`Remember, a style guide is only useful if it is used, updated, and enforced. Style Guides are useful for engineering-related documentation, sales and marketing materials, support docs, community contributions, and more.`

			`As changes are made to the overall Ansible site design, be sure to update this style guide with those changes. Or, should other resources listed below have major revisions, consider including company information here for ease of reference.`

			`This style guide incorporates current Ansible resources and information so that overall site and documentation consistency can be met.`

			`.. raw:: html`

			`<blockquote class="note info">`

Add a code-smell test for smart quotes and remove smart quotes from all files 7 years ago			`"If you don't find it in the index, look very carefully through the entire catalogue."`
			`― Sears, Roebuck and Co., 1897 Sears Roebuck & Co. Catalogue`
Remove more docs build errors (#45364) * orphans testing pages to avoid not-in-toctree errors * orphans various pages pending reorg * adds module_utils and special_vars to main TOC * uses a glob for scenario_guide TOC * normalize and Sentence-case headings on community pages, typos * re-orgs community TOC, adds all pages to toctree * removes scenario guides index page * adds style guide to community index * basic update to style guide * fix typo that created a new error * removes not-in-toctree from ignore errors list * leave removing files for future cleanup task 6 years ago
Added style guide (#24310) * Added style guide * Fixed index 8 years ago			`.. raw:: html`

			`</blockquote>`