Documentation should provide contextual guidance about when and why to use features, not just how to configure them. Additionally, strategically link to external documentation rather than duplicating content to reduce maintenance overhead.
Documentation should provide contextual guidance about when and why to use features, not just how to configure them. Additionally, strategically link to external documentation rather than duplicating content to reduce maintenance overhead.
When documenting configuration options or features:
Example of good contextual documentation:
## Azure URL Configuration
Different Azure deployments require different URL formats. Configure these options based on your deployment type:
| Deployment Type | useDeploymentBasedUrls | useCompletionUrls | Use Case |
|-----------------|------------------------|-------------------|----------|
| Standard API | false | false | Basic Azure OpenAI service |
| Custom Deployment | true | true | When using named model deployments |
For detailed Azure setup instructions, see the [official Azure OpenAI documentation](https://docs.microsoft.com/azure/cognitive-services/openai/).
This approach helps users understand not just what to configure, but when they need each configuration, while avoiding the maintenance burden of duplicating external documentation.
Enter the URL of a public GitHub repository