docs icon indicating copy to clipboard operation
docs copied to clipboard

Docs Writing Style Guide / Best Practices

Open Siegfried-B opened this issue 1 year ago • 4 comments

A draft document for a style guide. Can be used as a starting point.

Siegfried-B avatar Feb 08 '24 19:02 Siegfried-B

Anything necessary to be done before, e.g. @waveform06 can approve/merge?

Siegfried-B avatar Feb 08 '24 19:02 Siegfried-B

The page should be "user-ready" since folks will see it without the context of knowing it's a work in progress. It doesn't need to be content-complete, but it should not have blank sections.

Also, we need to add it to navigation.

jthiller avatar Feb 08 '24 23:02 jthiller

Ah, I thought it would be used "internally" by the contributors to the scribathon, only accessible through the Github repo for the time being. And inserted the templates/placeholders to make it easier for others to contribute and to make it clear that we probably need more categories.

Siegfried-B avatar Feb 09 '24 00:02 Siegfried-B

love "scribathon" 😄

For the purposes of this event we could just keep it in a PR or Issue. However, I think this has longterm value for docs contributors outside of this event.

jthiller avatar Feb 09 '24 00:02 jthiller