ComputerScienceHouse / devcade-docs

Public-facing technical documentation pertaining to the Devcade project (sans API)
https://devcade.csh.rit.edu/docs#/
MIT License
0 stars 3 forks source link

Refresh the whole docs site #6

Open MTFT-Games opened 7 months ago

MTFT-Games commented 7 months ago

General:

Cleanup:

Styles:

Content:

Devcade Install Guide (@esoccoli):

esoccoli commented 2 months ago

Specific changes to make

MTFT-Games commented 2 months ago

@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 commented 2 months ago

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

esoccoli commented 2 months ago

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

esoccoli commented 2 months ago

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.