Back to all reviewers

Documentation style and formatting

helix-editor/helix
Based on 3 comments
Markdown

Maintain consistent documentation style by following these guidelines: 1. Use concise, descriptive language for configuration and feature descriptions

Code Style Markdown

Reviewer Prompt

Maintain consistent documentation style by following these guidelines:

  1. Use concise, descriptive language for configuration and feature descriptions
  2. Format keyboard commands with <kbd> tags: <kbd>i</kbd>
  3. Use bold for mode names and important terms
  4. Use hyphens (-) instead of underscores (_) in parameter names and technical terms
  5. Keep descriptions clear and to-the-point

Example: ```markdown

Configuration

| Key | Description | Default | | ————– | —————————- | ——- | | auto-format | Enable auto-formatting | false |

Press i to enter Insert mode.

3
Comments Analyzed
Markdown
Primary Language
Code Style
Category

Source Discussions