We made the Cypress documentation exceptional by avoiding these mistakes.
Try to make your code snippets the real things someone can paste into the file and use right away.
Use tests and automatic dependency updates to keep examples up to date with the latest versions of the relevant library. Make it visible with dependency version badges.
A way to test Cypress examples in Markdown files to guarantee their correctness.
You can quickly write live interactive component documentation and make sure it works as expected by testing it.
Tag places in your private source code as good examples for others