logisim-evolution/logisim-evolution

Documentation

Open

#303 opened on Dec 17, 2019

View on GitHub
 (16 comments) (0 reactions) (0 assignees)Java (3,695 stars) (505 forks)batch import
documentationhelp wantedpri +1

Description

Hmmm, I also have to blame myself, but the current help system is out of date and needs some handling. Maybe a first step could be to first attack on the English version and than go to the other languages. Many new features are not/partly documented and make the use of logisim a lot easier to the targeted public, when documented. It would be great if we could maintain Carl Burch's standard of documentation; who wants to help?

Contributor guide

Tech stack
java
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.
active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
Basic knowledge of Logisim EvolutionEnglish language proficiencyFamiliarity with Markdown or help system format
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
50
Research direction
The issue states the current help system is outdated. To contribute, first review the existing help files in the repository, likely in a directory such as 'src/main/resources/doc'. Identify undocumented features by comparing the help content with the application's current feature set. Then, propose updates to the English version first, and later translations. The issue has 16 comments, some may contain guidance. Check the comments for specific areas needing documentation.