Skip to content
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.

Sign up for GitHub

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

Jump to bottom

[Documentation] Group utilities by category #240

Open
LucasCarrias opened this issue Jun 10, 2021 · 4 comments · May be fixed by #248
Open

[Documentation] Group utilities by category #240

LucasCarrias opened this issue Jun 10, 2021 · 4 comments · May be fixed by #248
Labels
help wanted Extra attention is needed

Comments

@LucasCarrias
Copy link
Contributor

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:
image

One suggestion is just to add a group title for each category in the docs, as this example from date-fns docs:
image
@hyanmandian
Copy link
Member

hyanmandian commented Jun 10, 2021 •
edited

Nice idea @LucasCarrias we just need to confirm if Docsify has support for that, can you help us with that?

@hyanmandian hyanmandian added the help wanted Extra attention is needed label Jun 10, 2021
@hyanmandian
Copy link
Member

What do you think @LucasCarrias of something like this?

image

@hyanmandian
Copy link
Member

We can enjoy that we going to change the docs and change sections names for something like that:

CPF -> Validate
CPF -> Generate
CPF -> Format

@hyanmandian hyanmandian linked a pull request Jun 15, 2021 that will close this issue
Open
@LucasCarrias
Copy link
Contributor Author

@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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
help wanted Extra attention is needed
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

docs: grouping utilities brazilian-utils/brazilian-utils
2 participants
@hyanmandian @LucasCarrias