Skip to content

Refresh the whole docs site #6

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

Draft
wants to merge 40 commits into
base: docs
Choose a base branch
from
Draft

Refresh the whole docs site #6

wants to merge 40 commits into from

Conversation

MTFT-Games
Copy link
Contributor

@MTFT-Games MTFT-Games commented Nov 30, 2023

General:

  • Enable auto table of contents
  • Enable auto2top
  • Proofread all content to ensure it is readable and grammatically correct.

Cleanup:

  • Remove random unnecessary stuff
  • Fill or remove any empty pages
  • Remove sections that are now redundant
  • Restructure sidebar / site
  • Remove old library page now that it gets pulled directly from the repo

Styles:

  • Replace current logo with the one that has text
  • Set the theme back to being from a cdn
  • Improve the "Edit on Github" button

Content:

  • Add a readme to the docs site
  • Make the site pull readme files from the other devcade repos
  • Add info to the home page
  • Update contribution guide
  • Review all content to ensure accuracy and sufficient detail
  • Add the docs site readme to the docs site
  • Confirm all links are working
  • Add links to all repos (beyond the edit button)
  • Add links between pages where appropriate
  • Add more content to first-game.md
  • Add content to cabinet.md (cad files, parts list, cost breakdown, links, etc)
  • Add content to gamepad.md (parts list, cost breakdown, links, etc)
  • Add pages explaining how to make a devcade game in other languages/programs/engines (at least the ones that people have made games with so far)
  • Add instructions/documentation for using cargo devcade

Devcade Install Guide (@esoccoli):

  • Remove all references to CSH specific aspects of the setup (ie: csh.rit.edu hostname, mentions of RTPs/Devcade Admins, etc)
  • Add info about configuring openbox
  • Add more headers and subheaders to make it easier to follow.
  • Maybe restructure and/or reword certain things to make it easier to follow
  • Make sure that the onboard will actually compile and run on this setup
    • If it doesn't, figure out why and add instructions for what needs to be done so it can run

Title got overriden and did nothing
description was not used and seems to do nothing.
The site doesn't work without the cdn for docsify scripts so loading them from cdn but not the theme just doesn't make sense.
The shortcut icon link seemed to do nothing so I removed it because I can.
Now it will pull from the readme in each repo. edit on github fix to come soon
Im gonna sleep now
This is to allow it to work properly with docs pulled from the other repos.
Also rigt aligned it like the original plugin did.
Apparently it did did do things, I just didn't notice
Probably caching being a bitch
- Removed a blenk line
- Removed the local dark style
Thinner one with text I think looks better
It was a copy of the readme from the library repo
Added a quick start section
Added a note on editing
@MTFT-Games MTFT-Games added documentation Improvements or additions to documentation enhancement New feature or request labels Nov 30, 2023
@MTFT-Games MTFT-Games self-assigned this Nov 30, 2023
MTFT-Games and others added 8 commits November 30, 2023 17:58
Now that readmes are pulled directly from repos, the outdated static versions here can go
The agreed upon standards were found and placed int he contributing file.
@pikachu0542
Copy link
Member

pikachu0542 commented May 1, 2024

Specific changes to make

  • Add more detail to the "Making your first devcade game" page
  • Update content of the onboard readme (it is comically out of date)
  • Fix the link to (and possibly update content of) the "Using the Game Template" page
  • Add more detail to the hardware overview page
  • Add content to or remove the "Cabinet" page
  • Add content to or remove the "Gamepad" page
  • Add headings to the "Installing DCU" page
  • Update all links in the "Internals" section
  • Possibly add more detail to the "API" page
  • Possibly add more detail to the "Monogame Game Template" page
  • Possibly add more detail to the "Flatpakify" page

@MTFT-Games
Copy link
Contributor Author

@esoccoli Some notes on the new install guide:
In addition to adding headers as you mentioned above, I would like to see it formatted more like a walk through or guide like the old one was.
Similarly, I've been trying to format the docs site with general information for anyone that might in the future want to make their own Devcade. To this point I would like to avoid specifying details specific to our instance of Devcade such as the dcu.csh.rit.edu hostname or referencing RTPs/Devcade Admins. These belong better on our wiki I think.
Do we need to specify mary's fork of flatpak still? or have the changes we need trickled down to the standard package yet?
We include an openbox config with the onboard, we could just add the volume control config to that... Or maybe as a separate PR.

MTFT-Games added 3 commits May 5, 2024 07:31
Now more of a 'heres where to start' instead of just a list of some of whats already on the sidebar
@MTFT-Games
Copy link
Contributor Author

@esoccoli Thoughts on not having the using-template page and instead just including that info in the readme of the template itself?

@pikachu0542
Copy link
Member

Id be fine with that. Most of the content is kinda just a repeat of what is in the readme of the template anyway

@pikachu0542
Copy link
Member

What I will say is that i can't guarantee that the onboard will actually launch after you finish following the instructions in the install guide. I was trying to test that, and it kept giving me errors, and I couldn't figure out why, and didn't really have the time to look into it too much.

@pikachu0542 pikachu0542 self-assigned this May 6, 2024
@pikachu0542 pikachu0542 added the help wanted Extra attention is needed label Mar 23, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request help wanted Extra attention is needed
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants