luckyframework / luckyframework/website
Add shard docs pages to website
Nobody has claimed this yet.
- Dominant language
- Crystal
- Stars
- 39
- Forks
- 62
- PR merge metrics
- No merged PRs in 30d
Description
I was thinking about this recently, but we only have _some_ of the shards include their `crystal docs` pages in their READMEs, but really we should have them accessible on the website too. Especially, if we want to include specific versions of Lucky.
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 reviewing the existing shard READMEs that already include `crystal docs` pages and how the website organizes documentation. Identify how specific Lucky versions should be represented, then make the relevant shard documentation pages accessible on the website and verify that the intended versions are covered.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- crystal
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100