Evercoder / Evercoder/culori

Organize API Docs

Open
#254 1 comment 2 reactions 0 assignees View on GitHub
Dominant language
JavaScript
Stars
1.2k
Forks
38
PR merge metrics
No merged PRs in 30d

Description

Would you accept a PR to organize the API docs a bit better?

Culori is great, but I find the docs to be pretty difficult to use, and it limits my ability to use the library. The main problems:
- The function list is in alphabetical order instead of grouped logically. eg. `blerp`, `lerp` and `unlerp` are not grouped together, so if you're unfamiliar with the library, you might overlook `blerp` and `unlerp`. I did. And it makes it really difficult to scan and get a quick sense of what's culori can do.
- Since the list of functions is at the top of the page and they link to anchors, you're always jumping back and forth, losing context.

I'd be happy to organize it so it's easier to use, but I figured I'd ask first before doing the work and putting up a PR. I think that having the functions in a fixed sidebar and grouping them logically would help a lot. I looked at the docs code and it seems like a straightforward change.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.