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

doc: add link to docsified engine wiki #5164

Merged
merged 2 commits into from
Nov 8, 2023
Merged

Conversation

jdrueckert
Copy link
Member

Note: broken README images are getting fixed in #5163

image

@github-actions github-actions bot added the Category: Doc Requests, Issues and Changes targeting javadoc and module documentation label Nov 6, 2023
@jdrueckert jdrueckert added Topic: UI/UX Requests, Issues and Changes related to screens, artwork, sound and overall user experience Type: Improvement Request for or addition/enhancement of a feature Size: S Small effort likely only affecting a single area and requiring little to no research labels Nov 6, 2023
@jdrueckert jdrueckert added this to the 2023 Revive - Milestone 2 milestone Nov 6, 2023
@@ -69,6 +70,11 @@ We are present in nearly the complete round-up of social networks. Follow/friend
</p>


## Knowledge Base

Find documentation, instructions, and helpful references in our [Terasology Knowledge Base](http://terasology.org/Terasology/#/), formerly known as the Terasology Engine wiki.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is the first time that I've heard it called the "Terasology Knowledge Base". Does it imply that the documentation there is player-facing now, as well as developer-facing? The wiki was predominantly a developer resource, with a few player pages for troubleshooting.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I called it that because @skaldarnar suggested that on Sunday and I think it's a good name.
I think it makes sense that the documentation is addressing different audiences (as also mentioned in #5148).
Having one place for all our documentation (irrespective of whether it's for players, devs, or maintainers) allows for easier management and overview as well as reduces siloing the different audience groups. They will have different ways of getting to that central documentation space for sure - e.g coming from the website (players or very new devs), coming from the game (players and devs), coming from github (devs), etc. - and will also have different sections within, but I think we can create a more homogenous feeling which makes it easier to cross the boundaries, e.g. from being a player to becoming a dev or from being a dev to becoming a maintainer.

@jdrueckert jdrueckert merged commit 478d579 into develop Nov 8, 2023
9 checks passed
@jdrueckert jdrueckert deleted the doc/add-docs-link branch November 8, 2023 16:58
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 Size: S Small effort likely only affecting a single area and requiring little to no research Topic: UI/UX Requests, Issues and Changes related to screens, artwork, sound and overall user experience Type: Improvement Request for or addition/enhancement of a feature
Projects
Status: No status
Status: No status
Development

Successfully merging this pull request may close these issues.

3 participants