Convert most of README into a single source file that lives in the Demo project
Open
Nobody has claimed this yet.
- Dominant language
- Swift
- Stars
- 210
- Forks
- 35
- Avg merge
- 1h 34m
- Merged PRs (30d)
- 1
Description
Convert most of README into a single source file that lives in the Demo project – this allows us to compile the README, so if the build fails, we can not allow merging. A nice way to prevent stale documentation.
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 reading the README and inspecting the Demo project and its build configuration. Identify which README sections should become source content and how that content can be compiled during the build. Done means the documentation is generated or compiled from the Demo project and a failed documentation build prevents merging.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- swift
- Domain
- build-system, documentation, mobile
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100