habsi/authentik
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

website/developer-docs: add a baby Style Guide (#9900)

Browse Source 
* draft style guide

* broken links

* rename partial file

* added content to style guide, more links

* sidebar and link

* polish

* typo

* forgot to save

* kens formatting trick

* typo

* Jens' edits

* tweak

* simplify formatting for variables

* edits from 4d62

* fixed link

* more edits

* tweak re formatting command

* tweak re formatting command

---------

Co-authored-by: Tana M Berry <tana@goauthentik.com>
This commit is contained in:
Tana M Berry
2024-06-13 09:10:59 -05:00
committed by GitHub
parent 89c08f2588
commit 8f82dac84e
9 changed files with 127 additions and 48 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
website/developer-docs/docs/templates/procedural.md vendored
View File

@ -9,7 +9,7 @@ title: "Procedural topic"
wget https://raw.githubusercontent.com/goauthentik/authentik/main/website/developer-docs/docs/templates/procedural.tmpl.md
```
Edit your markdown file as you work, reading this page for the descriptions of each section. You can build out a "stub file" with just headers, then gradually add content to each section. Use screenshots sparingly, only for complex UIs where it is difficult to describe a UI element with words. Refer to our [General Guidelines](../writing-documentation#general-guidelines) for writing tips and authentik-specific rules.
Edit your markdown file as you work, reading this page for the descriptions of each section. You can build out a "stub file" with just headers, then gradually add content to each section. Use screenshots sparingly, only for complex UIs where it is difficult to describe a UI element with words. Refer to our [General Guidelines](../writing-documentation#writing-guidelines) for writing tips and authentik-specific rules.
:::
For a procedural topic, use a title that focuses on the task you are writing about. For example, "Add a new Group" or "Edit user profiles". For procedural docs, there should be a verb in the title, and usually the noun (the component or object you are working on). For the title (and all headings) use the infinitive form of the verb (i.e. "add") not the gerund form (i.e. "adding").