-
Notifications
You must be signed in to change notification settings - Fork 549
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
Add MkDocs Documentation Based on Old Wiki #24
base: mirror/master
Are you sure you want to change the base?
Conversation
67111a5
to
2e1ac1d
Compare
This is a massive start, thank you so much for making this PR! 😄 |
25f11bc
to
fdf5ee7
Compare
c00c641
to
dacd4ca
Compare
5c41bfb
to
af7b190
Compare
I haven't really done any web development yet, so there is probably at lot to be improved here, but I styled the site a little and the contrast is better now. |
Looks better now. |
I am fairly familiar with working with MkDocs, I can probably look at this in more detail later this evening. Just to note, we also have https://ryujinx.dev reserved now 🙂. |
@Trigus42 Just restructured some things, |
I wish GitHub would allow commit amend force pushes on PR branches.. Me trying to get Actions to play nice ends up being 95% of the PR 🤣 |
May I suggest that we archive the contents of the old Ryujinx blog on GitHub pages at https://ryujinx.dev/? Future developers will need to understand the context behind why certain aspects of the codebase are the way they are, and the blog is a valuable source of documentation about the challenges they'd faced that could well be lost at some point in the future. |
@extherian I agree. A mirror of the blog might prove useful. However, I think this would be best discussed in a new issue, as there might be a bit more to it. There are two potential issues I can already think of:
|
I see, archive.org might be a better bet once it is back up and running, the important thing is that someone has it backed up in case it goes down. As far as copyright goes, I doubt it matters in practice since the original owners have washed their hands of it. |
This PR introduces a new documentation structure using MkDocs, transitioning from the old wiki format.
Changes Made
Current Status
Build and Serve the Documentation Locally:
Ensure you have Python and pip installed.
Install Material for MkDocs using pip:
Navigate to the project directory and run:
Open your browser at http://127.0.0.1:8000 to view the documentation.
GitHub Actions:
docs
branchdocs
branch is seleted in the Project Pages settings, the page is automatically deployed to GitHub Pages.