Prompt
Maintain consistent formatting and style in all documentation to improve readability and professionalism:
- Use proper formatting for code elements:
- Wrap boolean values in backticks:
true,falseinstead of true, false - Maintain prompt symbols (
$) in command-line examples:$ rails new app_name
- Wrap boolean values in backticks:
- Use correct Rails component names:
- Write “Active Record”, not “ActiveRecord”
- Write “Active Model”, not “ActiveModel”
- Write “Action View”, not “ActionView”
- Optimize cross-references:
- Add context links between related documentation sections:
See the [Getting Started Guide](getting_started.html#adding-authentication) for more details. - Link to sections within the same guide when possible to avoid navigating away
- Use standard URL patterns:
api.rubyonrails.orgnotedgeapi.rubyonrails.org
- Add context links between related documentation sections:
- Ensure example consistency:
- Make sure code examples match their accompanying explanatory text
- When updating code or descriptions, ensure both remain in sync
Following these conventions creates a cohesive documentation experience that helps developers find information quickly and understand it correctly.