Skip to content

Commit fd12ef1

Browse files
authored
Added a Best practices section to documentation.md
1 parent feea775 commit fd12ef1

1 file changed

Lines changed: 13 additions & 0 deletions

File tree

articles/documentation.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -130,6 +130,19 @@ The right sidebar will also display a list of contributors who have written an g
130130

131131
This will fail if the email is not found in the GitHub API, or if the email is not set as "public email" in the contributor's GitHub profile.
132132

133+
## Best practices
134+
135+
### Capitalization
136+
We capitalize our Headings in **Sentence Case**. Example: This is a heading of our docs
137+
138+
### Date and Time Format
139+
For date formats we use either:
140+
- International/European date format: `DD/MM/YYYY` (e.g., 01.04.2026)
141+
- ISO 8601: YYYY-MM-DD (e.g., 2026-04-01)
142+
For times we use eithe:
143+
- 24-Hour: `HH:mm:ss` (e.g., 14:30:05)
144+
- 12-Hour: `hh:mm:ss` tt (e.g., 02:30:05 PM). `AM/PM` is capitalized.
145+
133146
## Tables
134147

135148
Tables are supported in markdown. Here is an example:

0 commit comments

Comments
 (0)