Skip to content

Commit b762566

Browse files
committed
best practices
1 parent 8e5d348 commit b762566

File tree

1 file changed

+4
-9
lines changed

1 file changed

+4
-9
lines changed

text.mdx

Lines changed: 4 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -199,20 +199,15 @@ This line starts on a new line.
199199

200200
### Content organization
201201
- Use headers to create clear content hierarchy
202-
- Keep header levels logical (don't skip from H2 to H4)
202+
- Follow proper header hierarchy (don't skip from H2 to H4)
203203
- Write descriptive, keyword-rich header text
204204

205205
### Text formatting
206206
- Use bold for emphasis, not for entire paragraphs
207207
- Reserve italics for terms, titles, or subtle emphasis
208208
- Avoid over-formatting that distracts from content
209209

210-
### Links and navigation
211-
- Write descriptive link text instead of "click here"
212-
- Validate links regularly to maintain documentation quality
210+
### Links
211+
- Write descriptive link text instead of "click here" or "read more"
213212
- Use root-relative paths for internal links
214-
215-
### Accessibility
216-
- Ensure sufficient color contrast for all text
217-
- Use semantic formatting (headers for structure, not styling)
218-
- Provide alternative text for any embedded content
213+
- Test links regularly to prevent broken references

0 commit comments

Comments
 (0)