Leantime/leantime

Write documentation

Open

#1950 opened on Oct 4, 2023

View on GitHub
 (7 comments) (0 reactions) (0 assignees)PHP (9,827 stars) (957 forks)batch import
Help Wantedgood-first-issuehacktoberfest

Description

Our documentation needs an overhaul and be updated throughout. This may need someone who has worked with Leantime before but can also be a good beginner task if you want to learn more about Leantime. Docs Repo at: https://github.com/Leantime/docs

Contributor guide

Tech stack
None
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
over 1 week
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
Familiarity with Leantime concepts
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65
Research direction
Begin by reviewing the Leantime documentation repository at https://github.com/Leantime/docs. Familiarize yourself with the existing documentation structure and identify areas that need updating. Check the issue comments for any specific guidance from maintainers. Create a plan for overhauling the docs and propose changes via pull requests to the docs repo.