Improve `workflows` docs to explain on how init parameters are passed to blocks
Open
Nobody has claimed this yet.
enhancement
- Dominant language
- Python
- Stars
- 2.5k
- Forks
- 320
- Avg merge
- 1d 14h
- Merged PRs (30d)
- 133
Description
Search before asking
- I have searched the Inference issues and found no similar feature requests.
Description
Init params passing into blocs is a process that is not explained in docs.
Questions in PR indicating that: https://github.com/roboflow/inference/pull/343#discussion_r1585701369
Would be needed to create docs for that
Use case
No response
Additional
No response
Are you willing to submit a PR?
- Yes I'd like to help by submitting a PR!
Contributor guide
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 questions in PR #343's linked discussion and locate the existing workflows documentation. Document how init parameters are passed into blocks, using those questions to define the explanation. Done means the workflows docs clearly answer this process for readers.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100