AllenInstitute / AllenInstitute/ACE
Improved documentation
Open
Nobody has claimed this yet.
- Dominant language
- R
- Stars
- 4
- Forks
- 1
- PR merge metrics
- No merged PRs in 30d
Description
I already have a user-guide in the app. I'd like to do the following.
- Keep it up to date!
- Link to it from the main readme page.
- (optional) create an interactive readme to the tool (or a video tutorial) - Vilas or Tain may do this.
- Text description of what is being shown in each of the plots either via tool-tips or some other mechanism.
- Create an introduction section to the user guide and/or video about what ACE can be used for, and make an obvious button. What does ACE do and what doesn’t ACE do?
- Improve documentation for filtering by more than one thing.
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 existing user guide and the main README to inventory what is missing or outdated. Clarify which requested items are in scope, including plot descriptions, an ACE introduction, and multi-criteria filtering documentation; done means the agreed updates are published and the guide is linked from the README.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- r
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100