AllenInstitute / AllenInstitute/vis
Improve Documentation
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 10
- Forks
- 1
- Avg merge
- 10h 24m
- Merged PRs (30d)
- 7
Description
Is your feature request related to a problem? Please describe.
I think the docs could be improved
Describe the solution you'd like
Improve the docs so they are easier for new people to read and use. More documentation on using the logger.
Describe alternatives you've considered
N/A
Additional context
There will be more documentation improvement that could happen when we have the React components.
Contributor guide
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 with examples/readme.md, the documentation file named in the issue, and review the surrounding examples and logger usage. Clarify which newcomer workflows and logger details need coverage before editing. Done means the documentation is easier for new users to follow and explains logger usage more fully.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100