luckyframework / luckyframework/website
Clarity on some examples
Nobody has claimed this yet.
- Dominant language
- Crystal
- Stars
- 39
- Forks
- 62
- PR merge metrics
- No merged PRs in 30d
Description
Some of the examples assume that you generated a Full project, but if your first time with Lucky was with an API app, then some of the examples might be confusing.
If we mention `BrowserAction`, we can add a note mentioning that it's for Full apps, and API would use `ApiAction`.
Ref: https://github.com/luckyframework/lucky/issues/1207#issuecomment-648440329
We should probably also mention in the routing that you can only use 1 route per action. Technically you can use more than 1, but that will lead to some weird side effects, so we should just say only use 1. Let the multi route stuff for more of an expert escape hatch type deal.... I think eventually that will just raise an error and just say "no" 😛
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
Locate the website examples that mention BrowserAction and the routing documentation discussed in the issue. Check the corresponding Full and API app guidance, then update the examples to distinguish BrowserAction from ApiAction and clarify the one-route-per-action recommendation. Done means the examples are understandable for both project types and the routing limitation is explicit.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- crystal
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100