mirror of
https://github.com/DorkSquadRR/DorkNet.git
synced 2026-10-25 23:18:44 -07:00
Add initial documentation and structure for DorkNet project
- Create README.md for project overview and setup instructions - Add admin-ui/README.md for admin UI details and development setup - Introduce client-mod/README.md explaining the MelonLoader mod functionality - Establish docker/README.md for Docker setup and configuration - Create docs/README.md to index project documentation - Implement advanced-setup.md for Docker stack configuration - Document architecture in architecture.md - Provide easy-setup.md for hosting instructions - Add FAQ.md for common questions and legal considerations - Create joining-a-server.md for player connection instructions - Establish troubleshooting.md for common issues and resolutions - Introduce easy-app/README.md for the unified desktop application - Add server/README.md for ASP.NET Core backend details - Document tools/README.md for CLI helper scripts
This commit is contained in:
@@ -0,0 +1,10 @@
|
||||
# DorkNet docs
|
||||
|
||||
| Doc | For who |
|
||||
| -------------------------------------- | ---------------------------------------------------- |
|
||||
| [easy-setup.md](easy-setup.md) | Hosts who want the desktop-app one-click experience |
|
||||
| [advanced-setup.md](advanced-setup.md) | Hosts running a community server on a VPS |
|
||||
| [joining-a-server.md](joining-a-server.md) | Players whose friend gave them a join code |
|
||||
| [architecture.md](architecture.md) | Anyone hacking on the code |
|
||||
| [faq.md](faq.md) | Common questions before you ask in issues |
|
||||
| [troubleshooting.md](troubleshooting.md) | Known failure modes + fixes |
|
||||
Reference in New Issue
Block a user