-
Notifications
You must be signed in to change notification settings - Fork 1.3k
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: move wiki content to docsify page #5155
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Generally looks good, except for
- images and links in included README.md are broken (might be due to the move of
docs/images
?) - page titles are not shown except if they're explicitly included in the page content (probably due to wiki magic taking care of that before)
I'm getting an error trying to clone this with git (on Windows): If we keep files with |
Problem; Most pages don't have a title in the markdown, as the wiki previously displayed the page title based on the file name. Solution: Enable `autoHeader` to use the title from the `_sidebar.md` file on the pages itself.
@jdrueckert This should be addressed by 2a7cb52
@BenjaminAmos Addressed in 2789867 |
@jdrueckert Without touching the main README in this PR, I instead made the Home page of the wiki the landing page in fae7b47, so at least no broken images/links. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think this is good enough for the initial migration 👍
Contains
Merges the content of the Terasology wiki (from commit
e4d4b10424f24eed6583ea0e998da8aa32a27a3f
) into thedocs/
folder and set up a docsify page for it.How to test
The page can be previewed locally by starting a simple HTTP server from the
docs/
folder, for instance by runningOutstanding before merging
I think this is mostly functional by now. The wiki content itself is far from perfect, and I already removed a couple of dead links.
However, I think this is a task for follow-up PRs.
The following tasks should be performed after merging this:
docs-pre-merge/
intodocs
, but probably works better in a follow-up PR.mediawiki
pages