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 (1,646 stars) (73 forks)batch import
documentationgood first issue

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

Tech stack
elixirsvelte
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.
1-3 hours
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
basic knowledge of ExDoc
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80
Research direction
Review the existing README.md to identify comprehensive documentation that should be migrated to HexDocs. Then, create proper ExDoc module documentation in the source code (likely in lib/) and ensure that HexDocs is configured correctly (e.g., mix.exs). Finally, strip the README.md to only essential quickstart and reference information. Confirm the changes by building the documentation locally with `mix docs`.