When writing technical documentation, link to related concepts the first time they are mentioned, and include concrete examples to illustrate complex features or functionality.
When writing technical documentation, link to related concepts the first time they are mentioned, and include concrete examples to illustrate complex features or functionality.
When introducing a term or concept:
Example:
// Less helpful:
Turborepo's Environment Modes allow you to control which environment variables are available to a task at runtime.
// More helpful:
[Turborepo's Environment Modes](/repo/docs/core-concepts/environment-variables) allow you to control which environment variables are available to a task at runtime. For example:
```json
{
"envMode": "strict",
"env": ["API_KEY", "DEBUG"]
}
```
This approach helps readers immediately access relevant context without needing to search for it, and concrete examples make abstract concepts easier to understand and implement.
Enter the URL of a public GitHub repository