purescript / purescript/pursuit
Add basic guide to authoring inline Markdown docs to help pages
Open
Nobody has claimed this yet.
- Dominant language
- Haskell
- Stars
- 174
- Forks
- 47
- PR merge metrics
- No merged PRs in 30d
Description
I.e. continuing the work which was started in #337.
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 issue #337 and the existing help pages to understand the unfinished authoring guidance. Add a basic guide for writing inline Markdown documentation, and consider the work done when the help pages explain the authoring process clearly.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- markdown
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100