-
Notifications
You must be signed in to change notification settings - Fork 105
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[Documentation] Group utilities by category #240
Comments
Nice idea @lucascarrias we just need to confirm if Docsify has support for that, can you help us with that? |
What do you think @lucascarrias of something like this? |
We can enjoy that we going to change the docs and change sections names for something like that: CPF -> Validate |
@hyanmandian That looks pretty good! I really liked the grouping. However, I'm not quite sure if changing the function name by its action name is a common pattern in documentations. At least, thinking about docs like date-fns and lodash. That is just an impression that I'm bringing into discussion. Besides that, the docs seems to be cleaner and easier to navigate. |
At brazilian-utils site, All utilities are listed together without grouping by utility group/category, e.g CPF utilities, Boletos utilities and so on. Grouping the categories can make the navigation easier.
As you can see bellow, this is the current sidebar:
One suggestion is just to add a group title for each category in the docs, as this example from date-fns docs:
The text was updated successfully, but these errors were encountered: