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

Add overview guides to specific modules #1928

Closed
matthewmayer opened this issue Mar 14, 2023 · 2 comments · Fixed by #1929
Closed

Add overview guides to specific modules #1928

matthewmayer opened this issue Mar 14, 2023 · 2 comments · Fixed by #1929
Assignees
Labels
c: docs Improvements or additions to documentation p: 1-normal Nothing urgent
Milestone

Comments

@matthewmayer
Copy link
Contributor

One thing I find a little lacking in the faker documentation is that on module pages like https://next.fakerjs.dev/api/date.html its just a alphabetical list of methods, without much guidance on what the important methods are, any general scope on what the module is for, more detailed examples which use more than one method, whether data is localized, etc.

I was thinking it could be nice to add an overview section to the top of each guide page. I prepared a draft PR with a few samples. If you think this would be useful I'd be happy to work on some more.

@ST-DDT ST-DDT added c: docs Improvements or additions to documentation p: 1-normal Nothing urgent labels Mar 14, 2023
@ST-DDT ST-DDT moved this to Awaiting Review in Faker Roadmap Mar 14, 2023
@ST-DDT ST-DDT moved this from Awaiting Review to Todo in Faker Roadmap Mar 14, 2023
@ST-DDT ST-DDT moved this from Todo to In Progress in Faker Roadmap Mar 14, 2023
@matthewmayer
Copy link
Contributor Author

@faker-js/maintainers in general you are in favour of the idea?

@ST-DDT
Copy link
Member

ST-DDT commented Mar 18, 2023

I like it. It is like a short introduction to the module and conjeys more information than the current: "Module with methods related to xyz".

@github-project-automation github-project-automation bot moved this from In Progress to Done in Faker Roadmap Mar 29, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
c: docs Improvements or additions to documentation p: 1-normal Nothing urgent
Projects
No open projects
Status: Done
Development

Successfully merging a pull request may close this issue.

2 participants