openedx / openedx/frontend-app-authoring
Review ``README`` instructions for accuracy
Open
Nobody has claimed this yet.
good first issue
help wanted
- Dominant language
- TypeScript
- Stars
- 17
- Forks
- 218
- Avg merge
- 9d 20h
- Merged PRs (30d)
- 20
Description
In #1757 I made some minor updates to the README to direct people to Tutor, rather than the deprecated Devstack. However, someone should go through the README and test that all the instructions work, and update them where they no longer match how Tutor does things.
cc @tonybusa - this type of ticket could be a good first pass for your team.
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
Open the README and compare each setup and usage instruction with the current Tutor workflow. Test the documented steps; done means the instructions work with Tutor and outdated Devstack references or other mismatches are corrected.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- react, typescript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100