Skip to content

Commit

Permalink
Merge remote-tracking branch 'origin/master'
Browse files Browse the repository at this point in the history
  • Loading branch information
DrSmugleaf committed Jul 5, 2024
2 parents 1c1fc9d + ee562b3 commit e7e3a09
Show file tree
Hide file tree
Showing 131 changed files with 8,532 additions and 2,535 deletions.
1 change: 0 additions & 1 deletion .github/CODEOWNERS
Validating CODEOWNERS rules …
Original file line number Diff line number Diff line change
Expand Up @@ -5,5 +5,4 @@
/src/en/templates/ @moonheart08
/src/en/proposals/ @jezithyr
/src/en/templates/ @jezithyr
/src/en/space-station-14/core-design @jezithyr
/src/ru/* @ficcialfaint
27 changes: 26 additions & 1 deletion .github/labeler.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,5 +10,30 @@
"Scripts":
- 'scripts/**'

# I have tried making this robust (tm) using wildcards so many times but github docs for the labeler SUUUUCK. If you got time to figure it out please do it I give up.
# Welcome to the mega labeler.
"Design":
- 'src/en/proposals/**'
# General design
- 'src/en/space-station-14/accessibility/proposals/**'
- 'src/en/space-station-14/admin-tools/proposals/**'
- 'src/en/space-station-14/art/proposals/**'
- 'src/en/space-station-14/character-species/proposals/**'
- 'src/en/space-station-14/combat/proposals/**'
- 'src/en/space-station-14/mapping/proposals/**'
- 'src/en/space-station-14/player-interaction/proposals/**'
- 'src/en/space-station-14/roleplay-lore/proposals/**'
- 'src/en/space-station-14/round-flow/proposals/**'
- 'src/en/space-station-14/user-interface/proposals/**'

# Department design
- 'src/en/space-station-14/departments/atmos/proposals/**'
- 'src/en/space-station-14/departments/cargo-salvage/proposals/**'
- 'src/en/space-station-14/departments/command/proposals/**'
- 'src/en/space-station-14/departments/engineering/proposals/**'
- 'src/en/space-station-14/departments/medical/proposals/**'
- 'src/en/space-station-14/departments/science/proposals/**'
- 'src/en/space-station-14/departments/security/proposals/**'
- 'src/en/space-station-14/departments/service/proposals/**'

# General proposals
- 'src/en/general-proposals/**'
4 changes: 4 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,2 +1,6 @@
book
.idea/

# editor files
.*~
*.swp
17 changes: 9 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,15 @@
# Space Wizards Development Wiki

This is a port of the old Wiki.js SS14 documentation to `mdbook`, for the following benefits:
This is the `mdbook`-based developer documentation for all Space Wizards projects, including Robust Toolbox, Space Station 14, the SS14 launcher, etc. These docs cover many topics and can be potentially very useful for mappers, spriters, active contributors & prospective contributors, people who want to use our engine for their own projects, fork developers, and so on.

The site is currently hosted at [https://docs.spacestation14.com](https://docs.spacestation14.com).

Benefits of the current docs site infrastructure include:
- First-class git support, open source and actually editable by everyone
- No webshit bloat, much faster in general
- More familiar & comfortable for developers since `mdbook` use is very widespread
- No sign-on infrastructure or hosting necessary (besides GH pages)
- More customizable
- Friction to editing reduced significantly
- Decently familiar & comfortable for developers since `mdbook` use is very widespread
- No sign-on infrastructure or hosting necessary (besides GH pages), if forks would like to host their own
- Very low friction to adding new pages and editing/fixing old ones
- High level of customizability with styling and easy custom scripting
- Eventual localization support

The following `mdbook` features & plugins are available and in use:
Expand All @@ -18,8 +21,6 @@ The following `mdbook` features & plugins are available and in use:
- `mdbook-admonish`
- `mdbook-emojicodes`

The site is currently hosted at [https://docs.spacestation14.com](https://docs.spacestation14.com).

**For information such as how to edit, build & test these docs, see [Guide to Editing Docs](https://spacestation14.io/docs/en/meta/guide-to-editing-docs.html). on the site itself** (or [in this repo](./src/en/meta/guide-to-editing-docs.md))

## Screenshots
Expand Down
25 changes: 13 additions & 12 deletions book.toml
Original file line number Diff line number Diff line change
Expand Up @@ -56,13 +56,21 @@ warning-policy = "ignore" # false-positives like hell with absolute links & late
"/en/content/yaml/index.html" = "/en/general-development/tips/yaml-crash-course.html"
"/en/getting-started/pr-guideline/index.html" = "/en/general-development/codebase-info/pull-request-guidelines.html"
"/en/getting-started/conventions/index.html" = "/en/general-development/codebase-info/conventions.html"
"/en/content/chemistry/index.html" = "/en/space-station-14/chemistry.html"
"/en/content/writing-guidebook-entries/index.html" = "/en/general-development/tips/writing-guidebook-entries.html"
"/en/content/device-network/index.html" = "/en/space-station-14/device-network.html"
"/en/content/pow3r/index.html" = "/en/spcae-station-14/pow3r.html"
"/en/content/device-network/index.html" = "/en/space-station-14/core-tech/device-network.html"
"/en/content/pow3r/index.html" = "/en/spcae-station-14/departments/engineering/pow3r.html"
# yes this one is correct
"/en/content/construction/index/index.html" = "/en/space-station-14/construction.html"
"/en/content/destructible/index.html" = "/en/space-station-14/destructible.html"
"/en/content/construction/index/index.html" = "/en/space-station-14/core-tech/construction.html"
"/en/content/destructible/index.html" = "/en/space-station-14/core-tech/destructible.html"
"/en/content/mapping/index.html" = "/en/space-station-14/mapping/guides/general-guide.html"
"/en/content/mapping-sins/index.html" = "/en/space-station-14/mapping/guidelines.html"
"/en/content/mapping-checklist/index.html" = "/en/space-station-14/mapping/guidelines.html"
"/en/content/dungeons/index.html" = "/en/space-station-14/mapping/dungeons.html"
"/en/content/node-networks/index.html" = "/en/space-station-14/core-tech/node-networks.html"
"/en/content/NPCs/index.html" = "/en/space-station-14/core-tech/npcs.html"
"/en/content/cartridge-loader/index.html" = "/en/space-station-14/player-interaction/cartridge-loaders.html"
"/en/content/chemistry/index.html" = "/en/space-station-14/core-tech/chemistry.html"

"/en/administration/commands/index.html" = "/en/community/admin/admin-tooling/admin-command-cookbook.html"
"/en/administration/tooling/index.html" = "/en/community/admin/admin-tooling.html"
"/en/administration/policy/index.html" = "/en/community/admin/wizards-den-admin-policy.html"
Expand All @@ -80,13 +88,6 @@ warning-policy = "ignore" # false-positives like hell with absolute links & late
"/en/getting-started/troubleshooting/index.html" = "/en/general-development/tips/troubleshooting-faq.html"
"/en/config-reference/index.html" = "/en/general-development/tips/config-file-reference.html"
"/en/technical-docs/codebase-organization/index.html" = "/en/general-development/codebase-info/codebase-organization.html"
"/en/content/mapping/index.html" = "/en/space-station-14/mapping.html"
"/en/content/mapping-sins/index.html" = "/en/space-station-14/mapping/mapping-sins.html"
"/en/content/mapping-checklist/index.html" = "/en/space-station-14/mapping/mapping-checklist.html"
"/en/content/dungeons/index.html" = "/en/space-station-14/dungeons.html"
"/en/content/node-networks/index.html" = "/en/space-station-14/node-networks.html"
"/en/content/NPCs/index.html" = "/en/space-station-14/npcs.html"
"/en/content/cartridge-loader/index.html" = "/en/space-station-14/cartridge-loaders.html"
"/en/engine/ecs/index.html" = "/en/robust-toolbox/ecs.html"
"/en/engine/coordinate-systems/index.html" = "/en/robust-toolbox/coordinate-systems.html"
"/en/engine/net-entities/index.html" = "/en/robust-toolbox/netcode/net-entities.html"
Expand Down
204 changes: 161 additions & 43 deletions src/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,9 +35,10 @@ General Development
- [Config File Reference](en/general-development/tips/config-file-reference.md)
- [YAML Crash Course](en/general-development/tips/yaml-crash-course.md)
- [Feature Proposals](en/general-development/feature-proposals.md)
- [Feature Proposal Template](en/templates/proposal.md)
- [Expected Team Decorum & Usage](en/general-development/feature-proposals/expected-feature-proposal-decorum.md)
- [Core Game Design](en/space-station-14/core-design.md)

- [Work Groups](en/general-development/work-groups.md)
- [Contributing Translations](en/general-development/contributing-translations.md)

SS14 By Example
===============
Expand Down Expand Up @@ -93,56 +94,163 @@ Robust Toolbox
- [MIDI](en/robust-toolbox/midi.md)
- [Automatic Client Zip (ACZ)](en/robust-toolbox/acz.md)
- [Asset Packaging](en/robust-toolbox/asset-packaging.md)
- [Publishing a new version](en/robust-toolbox/publishing-robusttoolbox.md)
- [Publishing a new Robust Toolbox Version](en/robust-toolbox/publishing-robusttoolbox.md)

Space Station 14
================

----------------------
- [Core Game Design](en/space-station-14/core-design.md)
- [Design Principles](en/space-station-14/core-design/principles.md)
- [Antagonists](en/space-station-14/core-design/antagonists.md)
- [Mapping](en/space-station-14/mapping.md)
- [Mapping Checklist](en/space-station-14/mapping/mapping-checklist.md)
- [Mapping Sins](en/space-station-14/mapping/mapping-sins.md)
- [Chemistry](en/space-station-14/chemistry.md)
- [Solution Containers](en/space-station-14/chemistry/solution-containers.md)
- [Reagents](en/space-station-14/chemistry/reagents.md)
- [Metabolism](en/space-station-14/chemistry/metabolism.md)
- [Reactions](en/space-station-14/chemistry/reactions.md)
- [Construction](en/space-station-14/construction.md)
- [Destructible](en/space-station-14/destructible.md)
- [Device Network](en/space-station-14/device-network.md)
- [Pow3r](en/space-station-14/pow3r.md)
- [Cartridge Loaders](en/space-station-14/cartridge-loaders.md)
- [Node Networks](en/space-station-14/node-networks.md)
- [Dungeons](en/space-station-14/dungeons.md)
- [NPCs](en/space-station-14/npcs.md)

Design Proposals
================

----------------------
- [Core Design](en/space-station-14/core-design.md)
- [Design Principles](en/space-station-14/core-design/design-principles.md)

- [Core Tech]()
- [PR Guidelines](en/space-station-14/core-tech/guidelines.md)

- [Destructible](en/space-station-14/core-tech/destructible.md)
- [Construction](en/space-station-14/core-tech/construction.md)
- [Node Networks](en/space-station-14/core-tech/node-networks.md)
- [Displacement Maps](en/space-station-14/art/displacement-maps.md)
- [Device Network](en/space-station-14/core-tech/device-network.md)
- [NPCs](en/space-station-14/core-tech/npcs.md)
- [Chemistry](en/space-station-14/core-tech/chemistry.md)
- [Metabolism](en/space-station-14/core-tech/chemistry/metabolism.md)
- [Reactions](en/space-station-14/core-tech/chemistry/reactions.md)
- [Reagents](en/space-station-14/core-tech/chemistry/reagents.md)
- [Solution Containers](en/space-station-14/core-tech/chemistry/solution-containers.md)

- [Proposals]()

- [Accessibility](en/space-station-14/accessibility.md)
- [PR Guidelines](en/space-station-14/accessibility/guidelines.md)

- [Proposals]()

- [Admin Tooling](en/space-station-14/admin-tools.md)
- [PR Guidelines](en/space-station-14/admin-tools/guidelines.md)
- [Proposals]()

- [Art](en/space-station-14/art.md)
- [PR Guidelines](en/space-station-14/art/guidelines.md)

- [Proposals]()

- [Character/Species](en/space-station-14/characters-species.md)
- [PR Guidelines](en/space-station-14/character-species/guidelines.md)
- [Proposals]()

- [Combat](en/space-station-14/combat.md)
- [PR Guidelines](en/space-station-14/combat/guidelines.md)

- [Proposals]()

- [Feature Proposal Template](en/templates/proposal.md)
- [Mapping](en/space-station-14/mapping.md)
- [PR Guidelines](en/space-station-14/mapping/guidelines.md)

- [Dungeons](en/space-station-14/mapping/dungeons.md)

- [Guides]()
- [General Guide](en/space-station-14/mapping/guides/general-guide.md)

- [Proposals]()

- [Player Interaction](en/space-station-14/player-interaction.md)
- [PR Guidelines](en/space-station-14/player-interaction/guidelines.md)

- [Cartridge loaders](en/space-station-14/player-interaction/cartridge-loaders.md)

- [Proposals]()
- [PAI Expansion Slots](en/space-station-14/player-interaction/proposals/pai-expansion-slots.md)
- [PDA Messaging](en/space-station-14/player-interaction/proposals/pda-messaging.md)
- [Grid Inventory](en/space-station-14/player-interaction/proposals/grid-inventory.md)

- [Roleplay/Lore](en/space-station-14/roleplay-lore.md)
- [PR Guidelines](en/space-station-14/roleplay-lore/guidelines.md)
- [Proposals]()

- [Roundflow](en/space-station-14/round-flow.md)
- [PR Guidelines](en/space-station-14/round-flow/guidelines.md)

- [Antagonists](en/space-station-14/round-flow/antagonists.md)
- [Exterimator](en/space-station-14/round-flow/antagonists/exterminator.md)
- [Thief](en/space-station-14/round-flow/antagonists/thief.md)

- [Proposals]()
- [Cleanup Crew Gamemode](en/space-station-14/round-flow/proposals/cleanup-crew-gamemode.md)
- [Game Director](en/space-station-14/round-flow/proposals/game-director.md)
- [Pizza Delivery Critter](en/space-station-14/round-flow/proposals/pizza-delivery-critter.md)
- [Rogue Drones](en/space-station-14/round-flow/proposals/rogue-drones.md)
- [Turf War](en/space-station-14/round-flow/proposals/turf-war.md)
- [User Interface](en/space-station-14/user-interface.md)
- [PR Guidelines](en/space-station-14/user-interface/guidelines.md)
- [Proposals]()
- [Stat Panels](en/space-station-14/user-interface/proposals/statpanels.md)
- [Departments](en/space-station-14/departments.md)
- [Atmos](en/space-station-14/departments/atmos.md)
- [PR Guidelines](en/space-station-14/departments/atmos/guidelines.md)

- [Proposals]()
- [Atmos Rework](en/space-station-14/departments/atmos/proposals/atmos-rework.md)

- [Cargo/Salvage](en/space-station-14/departments/cargo-salvage.md)
- [PR Guidelines](en/space-station-14/departments/cargo-salvage/guidelines.md)

- [Proposals]()
- [Salvage Proposal](en/space-station-14/departments/cargo-salvage/proposals/salvage-proposal.md)

- [Command](en/space-station-14/departments/command.md)
- [PR Guidelines](en/space-station-14/departments/command/guidelines.md)
- [Proposals]()

- [Engineering](en/space-station-14/departments/engineering.md)
- [PR Guidelines](en/space-station-14/departments/engineering/guidelines.md)
- [Machine Upgrading Rework](en/space-station-14/departments/engineering/proposals/machine-upgrading-rework.md)
- [Pow3r](en/space-station-14/departments/engineering/pow3r.md)

- [Proposals]()
- [Engine Containment](en/space-station-14/departments/engineering/proposals/engine-containment.md)
- [Machine Upgrading Rework](en/space-station-14/departments/engineering/proposals/machine-upgrading-rework.md)
- [Power Generation Rework](en/space-station-14/departments/engineering/proposals/power-generation.md)
- [Signaller Rework](en/space-station-14/departments/engineering/proposals/signaller-rework.md)

- [Medical](en/space-station-14/departments/medical.md)
- [PR Guidelines](en/space-station-14/departments/medical/guidelines.md)

- [Proposals]()

- [Science](en/space-station-14/departments/science.md)
- [PR Guidelines](en/space-station-14/departments/science/guidelines.md)
- [Anomaly Cores](en/space-station-14/departments/science/anomaly-cores.md)

- [Proposals]()
- [XenoArch Redux (3MOArch)](en/space-station-14/departments/science/proposals/xenoarch-redux.md)
- [Xenobio](en/space-station-14/departments/science/proposals/xenobio.md)

- [Security](en/space-station-14/departments/security.md)
- [PR Guidelines](en/space-station-14/departments/security/guidelines.md)

- [Proposals]()
- [GenPop Prisoners](en/space-station-14/departments/security/proposals/genpop-prisoners.md)
- [Reduced Metagaming Mechanics](en/space-station-14/departments/security/proposals/reduced-metagaming.md)
- [Service](en/space-station-14/departments/service.md)
- [PR Guidelines](en/space-station-14/departments/service/guidelines.md)

- [Proposals]()
- [Plant Genetics](en/space-station-14/departments/service/proposals/plant-genetics.md)
- [Joker Roles](en/space-station-14/departments/service/proposals/joker_roles.md)

General Proposals
================

----------------------

- [Anomaly Cores](en/proposals/mirrorcult-anomaly-cores.md)
- [Machine Upgrading Rework](en/proposals/emogarbage-machine-upgrading-rework.md)
- [PDA Messaging](en/proposals/julian-vasilis-pda-messaging.md)
- [Plant Genetics](en/proposals/deltanedas-plant-genetics.md)
- [Security Genpop Rework](en/proposals/ike709-genpop-security.md)
- [Rogue Drones](en/proposals/mirrorcult-rogue-drones.md)
- [Game Director](en/proposals/tomleys-game-director.md)
- [Grid Inventory](en/proposals/emogarbage-grid-inventory.md)
- [Atmos Roadmap](en/proposals/notafet-atmos.md)
- [Cleanup Crew](en/proposals/mirrorcult-cleanup-crew-gamemode.md)
- [Exterminator](en/proposals/deltanedas-exterminator.md)
- [Power Generation Pattern](en/proposals/tday93-power-generation.md)
- [Turf War](en/proposals/deltanedas-turf-war.md)
- [Signaller Rework](en/proposals/deltanedas-signaller-rework.md)
- [Thief antagonist](en/proposals/theshued-thief.md)
- [Robust Hub](en/general-proposals/robusthub.md)

Server Hosting
==============
Expand Down Expand Up @@ -189,7 +297,12 @@ Community
- [Grafana Dashboards](en/community/infrastructure-reference/grafana-dashboards.md)
- [Space Wizards Hub Rules](en/community/space-wizards-hub-rules.md)
- [Space Wizards Role Hierarchy](en/community/space-wizards-role-hierarchy.md)
- [Space Wizards Maintainer List](en/community/space-wizards-maintainer-list.md)
- [Discord Rich Presence Repository](en/community/discord-rich-presence-repository.md)
- [Project Manager](en/community/projectmanager.md)
- [Maintainer](en/community/maintainer.md)
- [Maintainer Policy](en/community/maintainer/wizards-den-maintainer-policy.md)
- [Review Policy](en/community/maintainer/wizards-den-review-policy.md)
- [Admin](en/community/admin.md)
- [Admin Tooling](en/community/admin/admin-tooling.md)
- [Admin Command Cookbook](en/community/admin/admin-tooling/admin-command-cookbook.md)
Expand Down Expand Up @@ -217,6 +330,7 @@ Maintainer Meetings
==============

----------------------
- [2024-04-06](en/maintainer-meetings/maintainer-meeting-2024-04-06.md)
- [2024-03-23](en/maintainer-meetings/maintainer-meeting-2024-03-23.md)
- [2024-02-03](en/maintainer-meetings/maintainer-meeting-2024-02-03.md)
- [2024-01-20](en/maintainer-meetings/maintainer-meeting-2024-01-20.md)
Expand Down Expand Up @@ -263,5 +377,9 @@ Admin Meetings
==============

----------------------
- [2024-02-03](en/admin-meetings/admin-meeting-2024-02-03.md)
- [2024-05-18](en/admin-meetings/admin-meeting-2024-05-18.md)
- [2024-04-27](en/admin-meetings/admin-meeting-2024-04-27.md)
- [2024-03-30](en/admin-meetings/admin-meeting-2024-03-30.md)
- [2024-03-16](en/admin-meetings/admin-meeting-2024-03-16.md)
- [2024-02-17](en/admin-meetings/admin-meeting-2024-02-17.md)
- [2024-02-03](en/admin-meetings/admin-meeting-2024-02-03.md)
Loading

0 comments on commit e7e3a09

Please sign in to comment.