Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merge wiki documentation into docs/ documentation #66

Open
jdrueckert opened this issue Apr 18, 2021 · 0 comments · May be fixed by #74
Open

Merge wiki documentation into docs/ documentation #66

jdrueckert opened this issue Apr 18, 2021 · 0 comments · May be fixed by #74
Labels
Category: Doc Requests, Issues and Changes targeting javadoc and module documentation Good First Issue Good for learners that are new to Terasology Type: Improvement Request for or addition/enhancement of a feature

Comments

@jdrueckert
Copy link
Member

We currently have documentation for GooeyDefence in the repo wiki. Wikis IMO lack visibility and complicate the documentation process as the files are not as close to the code as they could be.

Hence, we're currently trying to improve this and introduced docsify-based documentation.
As a first step #18 was leveraged in #65 and the respective proposed documentation and comments solidified in docs/. As a next step, the documentation from the wiki should be merged into this.

Follow-up steps could later update the documentation according to the current implementation level (if not already up-to-date) and add new documentation as proposed for instance in #34.

@jdrueckert jdrueckert added Type: Improvement Request for or addition/enhancement of a feature Good First Issue Good for learners that are new to Terasology labels Apr 18, 2021
@jdrueckert jdrueckert moved this from Module Overhaul to ➡ Next Up in Highlighted Bugs & Gameplay Improvements Aug 27, 2022
@jdrueckert jdrueckert moved this from ➡ Next Up to 📔 Backlog in Highlighted Bugs & Gameplay Improvements Aug 27, 2022
mcvh48 added a commit to mcvh48/GooeyDefence that referenced this issue Apr 24, 2023
Merge the documentation given in the GooeyDefence wiki into
towers.md.

Closes Terasology#66
@mcvh48 mcvh48 linked a pull request Apr 24, 2023 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Category: Doc Requests, Issues and Changes targeting javadoc and module documentation Good First Issue Good for learners that are new to Terasology Type: Improvement Request for or addition/enhancement of a feature
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant