mlabs-haskell / mlabs-haskell/lambda-buffers
Leftovers for `docs/syntax.md`
Open
Nobody has claimed this yet.
documentation
frontend
- Dominant language
- Haskell
- Stars
- 32
- Forks
- 1
- PR merge metrics
- No merged PRs in 30d
Description
In #116, docs/syntax.md was created to specify a LambdaBuffers Frontend file. The chapter is a first draft, and needs improvement.
The remaining work is as follows:
- Rearranging grammar productions to be more consistent with internals: https://github.com/mlabs-haskell/lambda-buffers/pull/117#discussion_r1365086275
- Documenting behavior of imports: https://github.com/mlabs-haskell/lambda-buffers/pull/117#discussion_r1364915922
- General wording improvements / cohesiveness with other chapters.
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 docs/syntax.md and review the discussion threads linked from pull request #117 for the grammar-ordering and import-behavior requirements. Revise the chapter for consistent grammar ordering, document imports, and improve wording and cohesion with the other chapters; the documentation should cover all three listed areas.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100