itzg / itzg/docker-minecraft-server

Documentation structure is a mess

Open
#2,742 10 comments 0 reactions 0 assignees View on GitHub
documentation enhancement
Dominant language
Shell
Stars
14.3k
Forks
1.9k
Avg merge
2d 10h
Merged PRs (30d)
31

Description

### Enhancement Type

Improve an existing feature

### Describe the enhancement

The structure of the documentation, both in the docs folder as also what is pushed to readthedocs is a complete mess. I often find my self searching and finding the same information multiple places, as well we no consistent structure is present.

Also the meta documentation on the documentation setup is non-existient. :)

I would be happy to help with a restructure PR, to give something back to the community. If we start a simple discussion in this issue, maybe you are able to give enough guidance to how the setup is today.

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by reviewing the docs folder and the documentation setup used for Read the Docs. Map duplicated information and the current structure, then use the issue discussion to establish guidance before proposing a restructure. Done should include a consistent documentation structure and meta documentation for maintaining it.

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.