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

Add MkDocs Documentation Based on Old Wiki #24

Draft
wants to merge 20 commits into
base: mirror/master
Choose a base branch
from

Conversation

Trigus42
Copy link

@Trigus42 Trigus42 commented Oct 4, 2024

This PR introduces a new documentation structure using MkDocs, transitioning from the old wiki format.

Changes Made

  • Added MkDocs configuration files (mkdocs.yml).
  • Migrated existing content from the old wiki (taken from here) into the docs directory.
  • Added a workflow to automatically build and deploy the documentation to GitHub Pages.

Current Status

  • The documentation is functional and can be built using MkDocs.
  • While the migration is complete, the content still requires quite some work.
  • A preview of the documentation can be found at https://trigus42.github.io/ryujinx/.

Build and Serve the Documentation Locally:

  1. Ensure you have Python and pip installed.

  2. Install Material for MkDocs using pip:

    pip install mkdocs-material
    
  3. Navigate to the project directory and run:

     mkdocs serve
    
  4. Open your browser at http://127.0.0.1:8000 to view the documentation.

GitHub Actions:

  • The documentation is automatically built and pushed to the docs branch
  • When the docs branch is seleted in the Project Pages settings, the page is automatically deployed to GitHub Pages.

@github-actions github-actions bot added the infra label Oct 4, 2024
@regginator regginator self-assigned this Oct 4, 2024
@regginator
Copy link
Member

This is a massive start, thank you so much for making this PR! 😄

@regginator regginator force-pushed the mirror/master branch 2 times, most recently from 25f11bc to fdf5ee7 Compare October 4, 2024 03:21
@regginator regginator added the meta Change to documentation or other meta files such as the README label Oct 4, 2024
@CompeyDev
Copy link

Something to note - the icon we currently use doesn't contrast very well with the accent color of the site, would be worth choosing another complementary accent color.

image

@Trigus42 Trigus42 force-pushed the add-wiki branch 4 times, most recently from c00c641 to dacd4ca Compare October 5, 2024 21:55
@Trigus42 Trigus42 force-pushed the add-wiki branch 2 times, most recently from 5c41bfb to af7b190 Compare October 5, 2024 23:15
@Trigus42
Copy link
Author

Trigus42 commented Oct 5, 2024

Something to note - the icon we currently use doesn't contrast very well with the accent color of the site, would be worth choosing another complementary accent color.

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.

@Trigus42 Trigus42 marked this pull request as draft October 6, 2024 08:33
@CompeyDev
Copy link

Looks better now.

@regginator
Copy link
Member

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 🙂.

@regginator
Copy link
Member

@Trigus42 Just restructured some things, docs/ being migrated to docs/src/ could cause conflicts, so just letting you know 🙂

@regginator
Copy link
Member

regginator commented Oct 12, 2024

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 🤣

@extherian
Copy link

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.

@Trigus42
Copy link
Author

@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:

  • Copyright laws, as the content doesn't appear to be published under an open source license.
  • Storing and hosting the website content in a way that the community can maintain. I have mirrored the blog, and the total size is about 4.6 GB. This is very close to the 5 GB limit allowed for GitHub repositories. Since this is intended as an archive and shouldn't grow in size, we might be fine. However, GitHub staff may review anything exceeding 1 GB and could potentially disallow it.

@extherian
Copy link

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
infra meta Change to documentation or other meta files such as the README
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants