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.

Sign up for GitHub

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

doc: add link to docsified engine wiki #5164

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ff13f15
doc: add link to docsified engine wiki
jdrueckert Nov 6, 2023
785a556
Merge branch 'develop' into doc/add-docs-link
jdrueckert Nov 8, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@

<h3 align="center"><b>
<a href="#community">Community</a> |
<a href="#knowledge-base">Knowledge Base</a> |
<a href="#installation">Installation</a> |
<a href="#development">Development</a> |
<a href="#license">License</a>
Expand Down Expand Up @@ -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.



## Installation

<table>
Expand Down
Loading