autosoft-dev / autosoft-dev/tree-hugger

Better documentation

Open
#45 1 comment 0 reactions 0 assignees View on GitHub
documentation good first issue
Dominant language
Python
Stars
132
Forks
10
PR merge metrics
No merged PRs in 30d

Description

Well, the title of the issue tells it all, but just to clarify, we may need a better documentation (something in the read the docs or something like that, or a github page)

It is going to be a tricky work and a very necessary one.

Contributor guide

No contributing guide indexed for this repository

Research direction

The issue names no files, tests, or documentation entry point; begin by reviewing the repository's existing documentation and deciding whether Read the Docs or a GitHub page is in scope. Done means the project has a clearly defined, substantially improved documentation site or set of pages, but the issue needs scope and acceptance criteria before work can start.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
20/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.