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
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
40 commits
Select commit Hold shift + click to select a range
96237d7
Add a readme for the repo
MTFT-Games Nov 30, 2023
1fde0e8
Cleaned up index.html
MTFT-Games Nov 30, 2023
87941a1
Set the theme back to a cdn link and killed shortcut icon
MTFT-Games Nov 30, 2023
73bcfca
Added pulling in of other readmes
MTFT-Games Nov 30, 2023
04d2dac
Swap edit on github plugin for custom function
MTFT-Games Nov 30, 2023
ef12b83
Replaced shortcut icon
MTFT-Games Nov 30, 2023
a2e1665
Cleanup
MTFT-Games Nov 30, 2023
e1dfe45
Added editing instructions to readme
MTFT-Games Nov 30, 2023
13f0529
Swap logo
MTFT-Games Nov 30, 2023
14df2a4
Add table of contents in files
MTFT-Games Nov 30, 2023
5efeb4a
Removed library page
MTFT-Games Nov 30, 2023
42beb5b
Refreshed the home page
MTFT-Games Nov 30, 2023
a6720cd
Added auto2top
MTFT-Games Nov 30, 2023
a8f05c0
Make it darker
MTFT-Games Nov 30, 2023
01ef0bf
Quick typo fix in readme
MTFT-Games Feb 18, 2024
282a6e4
Typo fix on flatpakify
MTFT-Games Feb 18, 2024
0be876a
Create contributing guide
MTFT-Games Feb 18, 2024
bb101c7
Remove now redundant sections
MTFT-Games Feb 18, 2024
b9fcb41
Add style guides to contributing
MTFT-Games Feb 19, 2024
2b7378a
Updated the dcu install guide and reorganized the order of items on t…
pikachu0542 May 1, 2024
67a1cdf
Updated the using the game template page, and a couple very small mis…
pikachu0542 May 4, 2024
d4aa405
Add heading, summary, and hardware back to install guide
MTFT-Games May 5, 2024
11a2267
Re-add contributing guide to sidebar
MTFT-Games May 5, 2024
31ee800
Change up home page
MTFT-Games May 6, 2024
bfcb691
Move repo readmes under new how it works
MTFT-Games May 6, 2024
9786ffe
Fix link to new How it works
MTFT-Games May 6, 2024
e41fbed
Filled out the How it Works section
MTFT-Games May 6, 2024
2085ba2
Misc spelling and grammar fixes, also rewrote a paragraph on one of t…
pikachu0542 May 6, 2024
39b1f75
Added docsify to the package.json, updated readme
pikachu0542 Feb 4, 2025
aef6c46
Spellcheck how-it-works.md
MTFT-Games Mar 22, 2025
2ab3310
various added info
MTFT-Games Mar 22, 2025
aa53fcc
Move how it works to an overview sub page
MTFT-Games Mar 22, 2025
d5f86dd
Fill out most of cabinet.md
MTFT-Games Mar 22, 2025
a45b7bc
Fixed lack of newline after bullet point
MTFT-Games Mar 23, 2025
f683182
Renamed the 'getting started' section to 'making games'
pikachu0542 Mar 23, 2025
8f6ad1c
Moved the control diagram from Making games to gamepad
pikachu0542 Mar 23, 2025
7379f80
Split up contributing guide into the general contributing.md and a se…
pikachu0542 Mar 23, 2025
a1ae7c9
Expanded the gamepad page
pikachu0542 Mar 23, 2025
0d887f4
Improved the first game page
pikachu0542 Mar 23, 2025
c2c9d72
Did some reorganization and de-redundancy-ifying the docs
pikachu0542 Mar 23, 2025
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,6 @@ envs.py
.venv
venv/
users.sqlite3
launch.json
launch.json
node_modules
.vscode/
33 changes: 33 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
# Devcade Documentation

This repo contains or links to all relevant documentation for the Devcade project using docsify.

The official site is hosted at https://devcade.csh.rit.edu/docs#/

All documentation should live in the repo it applies to. If some documentation doesn't fit in any of the projects other repos, it may live here.

# Editing the docs

If something doesn't look right, you can edit any of the docs by going to the hosted site, finding the article that needs editing, and using the "Edit on github" button in the top right corner. Alternatively, you can go to the repo directly and find the relevant doc file. Once there, please make the appropriate edits and open a PR with your changes.

If a new page needs to be added to the sidebar, you should add it to the _sidebar file located at docs/_sidebar.md

If a new repo needs to be linked in, add an alias to the alias section of the index.html file.

For further changes to the docsify site overall, refer to the [docsify documentation](https://docsify.js.org/#/?id=docsify).

# Running locally

Install dependencies
```
npm i
```

And serve it, the site will then be available at `http://localhost:3000/docs/`
```
docsify serve . --open
```

# Deploying

Upon pushing to the docs branch, a webhook should take care of rebuilding the okd pod.
Loading