logisim-evolution / logisim-evolution/logisim-evolution

Documentation

Open
#303 20 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation help wanted pri +1
Dominant language
Java
Stars
7.6k
Forks
1k
Avg merge
17h 46m
Merged PRs (30d)
68

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

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the current English help system and comparing it with the newer features mentioned in the issue. The initial scope should be a clearly defined English documentation update; done means that selected features are documented consistently with Carl Burch's standard before work expands to other languages.

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
Active
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.