Back to all reviewers

Follow documentation conventions

grafana/grafana
Based on 7 comments
Markdown

Ensure documentation adheres to established style guidelines and technical standards: 1. **Use proper terminology and formatting:** - Write "data source" as two words, not "datasource"

Documentation Markdown

Reviewer Prompt

Ensure documentation adheres to established style guidelines and technical standards:

  1. Use proper terminology and formatting:
    • Write “data source” as two words, not “datasource”
    • Maintain proper capitalization for technical acronyms (e.g., “API” not “api”)
    • Use consistent language in UI descriptions (prefer “display” over “show”)
  2. Avoid possessives with product names:
    // Incorrect
    Grafana's dashboard features allow users to visualize data.
    Then we can use the following query for our graph panel.
       
    // Correct
    The dashboard features in Grafana allow users to visualize data.
    To call this stored procedure from a graph panel, use the following query.
    
  3. Use appropriate linking syntax:
    • For same-page references:
      [Supported Resources](#supported-resources)
      
    • For project pages, use Hugo shortcodes instead of ref: syntax:
           
      
  4. Handle deprecated features properly:
    • Don’t mention removed options in documentation
    • Provide clear alternatives for deprecated functionality
    • Add breaking change notices when documenting removed features
7
Comments Analyzed
Markdown
Primary Language
Documentation
Category

Source Discussions