docs: improve the README and other related documentation

Open
#116 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
25/100
Issue type
Documentation
Clarity
Needs clarification
Activity status
Stale
Domain
documentation

Research direction

Start by reviewing the README and any other documentation relevant to developers exploring or contributing to the repository. Define which gaps need addressing before making changes; done means the README and related documentation provide sufficient guidance for those audiences, but the issue does not specify the required content or scope.

Written by the indexing model from the issue text.

Description

Type/Docs
Current Limitation

The amount of documentation we have is not enough.

Suggested Improvement

Need to improve the README and other relevant information to help developers who are looking to explore/contribute.

Please select the package issue is related to
  • N/A
Version
  • N/A
Reporter Checklist
  • I have searched the existing issues and this is not a duplicate.
  • I have provided all the necessary information.
  • I have verified the improvement is not available in the latest version of the package.
Dominant language
TypeScript
Stars
18
Forks
67
Avg merge
4h 6m
Merged PRs (30d)
13

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from asgardeo/javascript

All issues in asgardeo/javascript

Similar issues

More TypeScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.