optics-dev / optics-dev/Monocle
Create an Internals.md document documenting the internals of Monocle
Open
Nobody has claimed this yet.
documentation
- Dominant language
- Scala
- Stars
- 1.7k
- Forks
- 207
- Avg merge
- 7h 59m
- Merged PRs (30d)
- 5
Description
We should create an Internals.md document documenting the internals of Monocle;
- What's where
- What are the different parts
- What structure these follow
For example, for core:
The parts are: - Optics declarations:
- Polymorphic optic trait, minimal implementation
- Simple Optic wrapper objects with constructors
- Function package:
- Why it's structured the way it is (to allow many datatypes to implement them)
- What's defined where
This could actually be quite a good in depth tutorial to Monocle.
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 surveying Monocle's core internals, especially the optic declarations and function package mentioned in the issue. Done means adding Internals.md that explains what's where, the different parts and their structure, including why the function package supports many datatypes, while serving as an in-depth tutorial.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- scala
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100