Prompt
Ensure documentation adheres to established style guidelines and technical standards:
- 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”)
- 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. - Use appropriate linking syntax:
- For same-page references:
[Supported Resources](#supported-resources) - For project pages, use Hugo shortcodes instead of ref: syntax:
- For same-page references:
- 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