mercurius-js / mercurius-js/auth
Improving the documentation
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 82
- Forks
- 17
- PR merge metrics
- No merged PRs in 30d
Description
We should take a look at the Mercurius Auth documentation to make sure it is super clear for new and existing users. We should also make sure it provides everything a developer needs to use and understand Mercurius Auth (without having to look closer at the underlying code/tests for example). Before starting an implementation, it would be great to understand the following:
- Does the docs structure make sense? What could be improved?
- Is the README sufficient? Is it missing any key information?
- Do we want a best practices/examples section?
- Anything else that is missing or think should be included?
Keen to hear everyone's thoughts on this!
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing the README, then compare its coverage with the underlying code and tests mentioned in the issue. Identify gaps in structure, essential usage information, examples, and best practices; the work is complete when the documentation scope and proposed improvements are agreed before implementation.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- graphql, javascript, nodejs
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100