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.

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

Docs: add a link to the source code for each utility #75

Closed
Tracked by #69
takanome-dev opened this issue Nov 4, 2023 · 0 comments
Closed
Tracked by #69

Docs: add a link to the source code for each utility #75

takanome-dev opened this issue Nov 4, 2023 · 0 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@takanome-dev
Copy link
Collaborator

takanome-dev commented Nov 4, 2023

What would you like to share

Add a link to the source code for each utility. Since every H4 element in the doc source files is a heading for a utility we can attach these links by dynamically attaching the heading title to a path pattern to the repository

Here's an example from the Lodash docs

As you can see above, source and npm package are links that lead to external resources. In this case, we only need to link to the source. Also, notice how the details for each component are laid out in a well-spaced manner making readability a breeze. All the utilities are documented using a uniform schema containing the fields:

  • Parameters
  • Description
  • Returns
  • Example

Maybe a React component to template this layout would be efficient.

@takanome-dev takanome-dev added documentation Improvements or additions to documentation enhancement New feature or request labels Nov 4, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants