luckyframework / luckyframework/website

Document Avram::Params

Open
#1,076 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Crystal
Stars
39
Forks
62
PR merge metrics
No merged PRs in 30d

Description

This is used as a way to pass raw data to operations.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the website's existing documentation for Avram and operations, then find the appropriate place for an Avram::Params entry. Clarify how it passes raw data to operations and document that usage with an example; done means the type has a discoverable, accurate explanation.

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.