Add "Search terms" to each function's docs page #195
aleclarson
started this conversation in
Ideas
Replies: 2 comments 6 replies
-
|
I could help with it. However, I might like the structure. ### Search terms
- Often called `slugify`, `kebabCase`, or `hyphenate` in other libraries.
### Popular use cases:
- Converting titles to URL-friendly formats by replacing spaces with dashes.
- Creating consistent, dash-separated CSS class names from multi-word strings.
- Generating SEO-friendly slugs for blog posts or website content.
- Normalizing user input into dash-separated identifiers.
- Preparing filenames by transforming descriptive phrases into dash-separated strings.Another point: It will generate a significant amount of new documentation, resulting in a large PR that may pose a challenge for review. I believe it would be more efficient to divide it into smaller PRs for each module. What do you think? |
Beta Was this translation helpful? Give feedback.
1 reply
-
Module documentation progress |
Beta Was this translation helpful? Give feedback.
5 replies
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
-
The idea here is to make searching the docs more likely to turn up a function you're looking for by describing possible use cases and alternative names often used by other implementations.
For example, the
dashdocs might have:LLM assistance
LLMs like ChatGPT can help out with this task. For example, I used the following prompt to generate the above example:
Beta Was this translation helpful? Give feedback.
All reactions