Skip to content

Commit

Permalink
Move doc style guide
Browse files Browse the repository at this point in the history
  • Loading branch information
mamoodi committed Jan 2, 2025
1 parent f14c641 commit 0bddd06
Showing 1 changed file with 14 additions and 3 deletions.
17 changes: 14 additions & 3 deletions DOC_STYLE_GUIDE.md → docs/DOC_STYLE_GUIDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,14 @@

- **Clarity & Conciseness**: Always prioritize clarity and brevity. Avoid unnecessary jargon or overly complex explanations.
Keep sentences short and to the point.
- **Stick to the Goal**: Focus on the topic's main objective. Ensure that the documentation addresses the most common
use cases first and leaves more detailed or advanced configurations for later sections.
- **Gradual Complexity**: Start the user with the simplest, most basic setup, and then gradually introduce more advanced
concepts and configurations.

## Formatting Guidelines

### Headers

Use **Title Case** for the first and second headers.
Use **Title Case** for the first and second level headers.

Example:
- **Basic Usage**
Expand All @@ -34,3 +34,14 @@ Example:
1. Step one: Do this.
2. Step two: Complete this action.
3. Step three: Verify the result.

### Code Blocks

* Use code blocks for multi-line inputs, outputs, commands and code samples.

Example:
```bash
docker run # ...
-e THIS=this \
-e THAT=that
```

0 comments on commit 0bddd06

Please sign in to comment.