OpenRCT2 / OpenRCT2/OpenRCT2

Improve documentation

Open
#12,046 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement epic
Dominant language
C++
Stars
16.2k
Forks
1.9k
Avg merge
1d 20h
Merged PRs (30d)
80

Description

Currently, there are some problems with documentation:

  1. There is not nearly enough of it.
  2. User documentation and development documentation is mixed.
  3. Documentation is spread out over too many places. In many cases, there is duplication, instead of linking people to the correct place. These places are:
    3.1. The OpenRCT2 wiki
    3.2. docs.openrct2.io (not working since the move from .website to .io now fixed)
    3.3. openrct2.org No longer active
    3.4. openrct2.io (Getting Started) moved to docs.openrct2.io
    3.5. readme.md moved to wiki

Instead, the documentation should be reorganised as follows:

  • 1. User documentation should go to docs.openrct2.io, which should also revert to RST/ReadTheDocs.
  • 2. Technical documentation should stay on the OpenRCT2 wiki - for now at least.
  • 3. Both should be vastly expanded.

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

Review the current documentation locations listed in the issue, especially docs.openrct2.io and the OpenRCT2 wiki, and compare them with the stated organization. The remaining work is to identify concrete documentation gaps and expand the appropriate user and technical documentation without duplicating content.】【。}

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.