LavaMoat / LavaMoat/lavamoat.github.io
create docs for each package
Open
Nobody has claimed this yet.
documentation
enhancement
- Dominant language
- MDX
- Stars
- 3
- Forks
- 3
- PR merge metrics
- No merged PRs in 30d
Description
In the contributor's project structure section, each link within the tree should point to documentation about that given package. Whether this is just a copy of the README.md or not is TBD.
Ref: #5 for temporarily removing the links.
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 with the contributor's project structure section and inspect the package tree and each package's README.md. Use issue #5 for context on the temporarily removed links. Done means every package link points to documentation for that package, with the documentation source and format resolved first.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- markdown
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100