#193 Create style guide
Opened 3 months ago by bcotton. Modified a month ago

For both written style (e.g. say "Red Hat" instead of "RedHat") and technical style (e.g. "don't use :toc: in docs)

Inspired by this Discussion thread


Fedora Magazine has some style guidelines. Many of them would apply, although some of them are not applicable since it's a different style of writing.

Metadata Update from @bcotton:
- Issue assigned to bcotton

2 months ago

For both written style (e.g. say "Red Hat" instead of "RedHat") and technical style (e.g. "don't use :toc: in docs)

Inspired by this Discussion thread

How about the Red Hat style guide (see https://redhat-documentation.github.io/) for consistency?

How about the Red Hat style guide (see https://redhat-documentation.github.io/) for consistency?

That would be a good starting point, and a "if you don't see it in here, refer there", but there may be places where we'll want to diverge from that. And there are definitely places we'll want to supplement it.

Another thing to include is guidance for admonitions. (See KDE for an example and Discussion for my thoughts on reducing our admonition set)

Login to comment on this ticket.

Metadata
Boards 1
Documentation Content Status: Backlog