Join GitHub today
GitHub is home to over 28 million developers working together to host and review code, manage projects, and build software together.Sign up
Improve the content of the CanJS documentation #4116
TLDR: we propose reviewing our current docs to look for:
Our docs have evolved over the years without a thorough review. Inevitably, some docs have deteriorated with broken links, out-of-date examples, and busted demos. Some pages lack good content or examples.
Review the most popular pages (maybe top 50?) to:
Additionally, we should tackle these existing issues:
We should also look at issues with the “documentation” label.
As a stretch goal, we should consider:
This isn’t something we have to address as part of tackling this proposal, but where we’re already updating code… @CODE-REaD brings up a good point that more distinctive variable & property names can make it easier to understand code examples: https://forums.donejs.com/t/generic-property-names-confuse-the-beginner/908