Documentation should provide thorough technical explanations that define key concepts, explain behaviors, and include necessary context for users to properly understand and use features. Avoid leaving users to guess what terms mean or how features differ from similar functionality.
Documentation should provide thorough technical explanations that define key concepts, explain behaviors, and include necessary context for users to properly understand and use features. Avoid leaving users to guess what terms mean or how features differ from similar functionality.
Key practices:
Example of insufficient explanation:
--compare-desired Compare revision with desired state instead of live state
Example of comprehensive explanation:
--compare-desired Compare revision with desired state instead of live state
"Desired state" refers to the configuration stored in Git that Argo CD should apply.
This differs from the normal diff behavior which compares:
- Live state (current cluster state) vs desired state (Git configuration)
Instead, this flag compares:
- Desired state (Git configuration) vs desired state (Git configuration at different revision)
Enter the URL of a public GitHub repository