Configuration changes and examples should be documented with clear formatting, proper context, and helpful references to aid developer understanding.
Configuration changes and examples should be documented with clear formatting, proper context, and helpful references to aid developer understanding.
When documenting configuration changes:
Example of clear configuration documentation:
// nx.json
{
"plugins": [
{
"plugin": "@nx/dotnet",
"options": {
- "inferredTargets": {
- "build": "build",
- "test": {
- "targetName": "test:dotnet",
- "cache": false
- }
- }
+ "build": {
+ "targetName": "build"
+ },
+ "test": {
+ "targetName": "test:dotnet"
+ }
}
}
]
}
This approach helps developers quickly understand what configuration files are being modified, what specific changes are needed, and where to find additional information about configuration options.
Enter the URL of a public GitHub repository