Documentation should follow consistent formatting and structural patterns to maximize readability and maintainability. Key guidelines: 1. Keep line lengths to 80 characters maximum
Documentation should follow consistent formatting and structural patterns to maximize readability and maintainability. Key guidelines:
Example of proper documentation formatting:
# Feature Name
Default behavior description first, followed by any exceptions or special cases.
## Usage
```js
// Code example with proper indentation
const example = require('node:example');
example.doSomething();
option1
{string} Description fits within 80 chars, continues on next
line with proper indentation.option2
{Object} Another option description.```
This format ensures consistency across documentation and makes it easier for users to find and understand information.
Enter the URL of a public GitHub repository