luckyframework / luckyframework/website
Document more escape hatches
Nobody has claimed this yet.
- Dominant language
- Crystal
- Stars
- 39
- Forks
- 62
- PR merge metrics
- No merged PRs in 30d
Description
There's specific escape hatches like using `where("...")` in queries and such that allow you to get around some limitations. We just need a clean way to show these are not preferred methods, and should be avoided when possible.
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 locating the website's query documentation and the sections covering where("...") and related escape hatches. Identify the limitations each workaround addresses, then document them with clear warnings that they are not preferred when alternatives exist. Done means the relevant escape hatches are easy to find and consistently described.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- crystal
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100