Basic Syntax / Lists

Lists

Lists are most useful when they turn vague notes into actions: what changed this week, what ships next, and what happens first.

Unordered Lists

Use unordered lists when sequence does not matter:

- Rewrite the homepage around workflows
- Add Intro to the main navigation
- Fix low-contrast text in dark mode

Ordered Lists

Use ordered lists when the reader should follow steps in sequence:

1. Preview the site locally
2. Check links and screenshots
3. Run npm run build
4. Publish to GitHub Pages

Nested Lists

Indent child items when you need a second level of detail:

- This week's docs work
  - Rewrite headings and links pages
  - Update examples to match real docs workflows
- Release checks
  1. Run npm run build
  2. Verify the English entry points

Preview

This week:

  • Refresh the homepage voice
  • Rewrite high-traffic syntax pages
  • Recheck language switching

Release order:

  1. Review visuals and links
  2. Run the build
  3. Confirm output paths
  4. Push the update

Writing Tips

  • Use unordered lists for collections and ordered lists for procedures.
  • Start each item with a clear noun or verb so readers can scan quickly.
  • Keep nesting shallow. If you need too many levels, a heading or table is probably a better fit.
  • If you need progress tracking, a task list is usually a better next step than a plain list.

Comments

Comments are currently unavailable.

Enable GitHub Discussions for this repository and complete the giscus configuration to turn comments on.