luckyframework / luckyframework/website
Refactor the entire Operation related guides
Nobody has claimed this yet.
- Dominant language
- Crystal
- Stars
- 39
- Forks
- 62
- PR merge metrics
- No merged PRs in 30d
Description
After working on https://github.com/luckyframework/website/pull/518 I realized that our "validating and saving" guides are a mess. We now have both Operation and SaveOperation which do work very similar, but have some unique concepts. We need to rethink how we can lay out this page. I'm think we actually break it out in to several sub pages. Not sure how we can do this yet, but what I'm thinking is like:
```
database
| validating and saving
| callbacks
| validations
| needs, attributes, permit_columns....
| Operation VS SaveOperation
```
I don't know.... I'm not sold on that, but the idea being a secondary sub-level so we can do a whole page on just callbacks, or a whole page on just validations....
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 reading the existing “validating and saving” guides and compare the documented Operation and SaveOperation concepts. Decide on the page structure for callbacks, validations, needs, attributes, permit_columns, and the Operation versus SaveOperation distinction; done means the guides are reorganized into a clear structure.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- crystal
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100