woutdp/live_svelte

Add documentation to HexDocs instead of readme

Open

#35 opened on Apr 21, 2023

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Elixir (73 forks)batch import
documentationgood first issue

Repository metrics

Stars
 (1,646 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

The documentation is getting a bit unwieldly, so let's move most things over to HexDocs and keep just the bare minimum in the README.md

Contributor guide

Research direction
Examine existing README and identify sections to move to HexDocs, then create appropriate module documentation files.
Tech stack
elixir
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Elixir
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85