Join GitHub today
GitHub is home to over 31 million developers working together to host and review code, manage projects, and build software together.Sign up
Group API docs by purpose instead of collection #3404
tldr; Our packages should be grouped by purpose instead of by collection. This proposes to reorganize the documentation and give new users a more simplified understanding of CanJS.
The API docs sidebar looks like:
There are two problems with the API docs:
Intimidating new users
Listing 60 packages makes CanJS seem way too big. Most of these packages they will never have to use, or use very rarely.
Organized by collections instead of purpose
While being organized by collection is useful at focusing people's attention on what they will primarily use, it does little to inform people what a given package actually does.
I would like to group our packages by purpose while still retaining the ability to "focus" new users on the APIs that they need to know.
The following is a rough idea of what the sidebar might look like to a new user:
The following shows most of CanJS's packages organized this way:
Here's another idea:
2.) Show colored squares next to each package according to group they belong to. In the example below,
Note that the color for each group would needs more consideration, I just picked some random colors to show this concept.