Maintain consistent style in documentation files to improve readability and professionalism. Specifically: 1. **Command references**: Use a consistent format when referring to CLI commands. Prefer either:
Maintain consistent style in documentation files to improve readability and professionalism. Specifically:
terraform fmt
command” (includes both “The” and “command”)terraform fmt
:” followed by a descriptionExample:
# Recommended
- `backend.tf`: Your backend configuration
- `main.tf`: Resource and data source blocks
- `variables.tf`: Variable blocks in alphabetical order
# Instead of
- `backend.tf`: Your backend configuration.
- `main.tf`: Resource and data source blocks.
- `variables.tf`: Variable blocks in alphabetical order.
Consistent documentation formatting ensures that users can quickly scan and comprehend content, while maintaining a professional appearance throughout the codebase.
Enter the URL of a public GitHub repository