Who actually wants a step-by-step tutorial/example ...?
- Dominant language
- Elixir
- Stars
- 451
- Forks
- 63
- Avg merge
- 1d 8h
- Merged PRs (30d)
- 1
Description
The docs in _most_ projects are:
The `README.md` and tests of _this_ project are _already_ better than 99.9% of other GitHub/software projects ...
As someone learning a new language or framework, I find end-to-end tutorials _super_ useful. 😍
But as someone who just wants to _ship_ a product, :shipit:
Writing step-by-step tutorials/examples takes a _very_ long time ... ⏳
Some of our examples have been immensely popular in terms of views & stars, ⭐️
but even the most popular ones have almost **_zero_ feedback** from the readers ... 😞
If you're reading this, and you feel you would _benefit_ from another step-by tutorial/example,
please leave a comment below. 💬
Contributor guide
Research direction
Start by reading README.md and the existing tests, then review the project's current examples. The issue asks for feedback rather than naming a specific tutorial or entry point; completion would require an agreed end-to-end tutorial scope and documentation, which is not defined here.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- elixir
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 20/100