diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml index 96c2fe6d8..89a2ffc16 100644 --- a/.github/workflows/deploy.yml +++ b/.github/workflows/deploy.yml @@ -28,10 +28,16 @@ jobs: run: | curl --proto '=https' --tlsv1.2 https://sh.rustup.rs -sSf -y | sh rustup update - - name: Install mdbook & plugins + - name: Install mdbook-spacewizards + uses: jaxxstorm/action-install-gh-release@v1.10.0 + with: # Grab a specific tag with caching + repo: space-wizards/mdBook-spacewizards + tag: v0.4.35 + cache: enable + - name: Install plugins uses: taiki-e/install-action@v2.18.6 with: - tool: mdbook@0.4.34,mdbook-admonish@1.11.1,mdbook-linkcheck@0.7.7,mdbook-mermaid@0.12.6,mdbook-template@1.1.0,mdbook-emojicodes@0.3.0 + tool: mdbook-admonish@1.11.1,mdbook-linkcheck@0.7.7,mdbook-mermaid@0.12.6,mdbook-template@1.1.0,mdbook-emojicodes@0.3.0 - name: Setup Pages id: pages uses: actions/configure-pages@v3 diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml index 528eab872..9b315354b 100644 --- a/.github/workflows/test.yml +++ b/.github/workflows/test.yml @@ -14,10 +14,16 @@ jobs: run: | curl --proto '=https' --tlsv1.2 https://sh.rustup.rs -sSf -y | sh rustup update - - name: Install mdbook & plugins + - name: Install mdbook-spacewizards + uses: jaxxstorm/action-install-gh-release@v1.10.0 + with: # Grab a specific tag with caching + repo: space-wizards/mdBook-spacewizards + tag: v0.4.35 + cache: enable + - name: Install plugins uses: taiki-e/install-action@v2.18.6 with: - tool: mdbook@0.4.34,mdbook-admonish@1.11.1,mdbook-linkcheck@0.7.7,mdbook-mermaid@0.12.6,mdbook-template@1.1.0,mdbook-emojicodes@0.3.0 + tool: mdbook-admonish@1.11.1,mdbook-linkcheck@0.7.7,mdbook-mermaid@0.12.6,mdbook-template@1.1.0,mdbook-emojicodes@0.3.0 - name: Build with mdBook run: mdbook build - name: Upload artifact diff --git a/README.md b/README.md index b507cdb27..0fcf73c41 100644 --- a/README.md +++ b/README.md @@ -18,6 +18,8 @@ The following `mdbook` features & plugins are available and in use: - `mdbook-admonish` - `mdbook-emojicodes` +This repo uses a custom version of `mdbook` available [here](https://github.com/space-wizards/mdBook-spacewizards). + 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)) diff --git a/book.toml b/book.toml index aad926134..bdf8615a8 100644 --- a/book.toml +++ b/book.toml @@ -1,11 +1,15 @@ [book] authors = ["Space Wizards Contributors"] -language = "en" -multilingual = false src = "src" title = "Space Wizards Development Wiki" description = "Tutorial & reference for all Space Wizards Federation projects, including the Robust Toolbox engine and its flagship open source game, Space Station 14." +[language.en] +name = "English" + +[language.ru] +name = "Русский" + [preprocessor.mermaid] [preprocessor.admonish] @@ -13,8 +17,8 @@ assets_version = "2.0.2" # do not edit: managed by `mdbook-admonish install` [preprocessor.emojicodes] -[preprocessor.template] -before = ["mermaid","admonish","emojicodes"] # templates can include these so we run this first +#[preprocessor.template] +#before = ["mermaid","admonish","emojicodes"] # templates can include these so we run this first [output.html] additional-js = ['scripts/mermaid.min.js', 'scripts/mermaid-init.js', 'scripts/nav-additions.js'] @@ -39,9 +43,9 @@ level = 1 [output.html.playground] runnable = false # sorry we arent rustpilled :( -[output.linkcheck] -traverse-parent-directories = false -warning-policy = "ignore" # false-positives like hell with absolute links & latex, so.. cant do +#[output.linkcheck] +#traverse-parent-directories = false +#warning-policy = "ignore" # false-positives like hell with absolute links & latex, so.. cant do # Redirects # These are used to map between old Wiki.js links and current docs site links, diff --git a/src/SUMMARY.md b/src/SUMMARY.md deleted file mode 100644 index 9c37e3f09..000000000 --- a/src/SUMMARY.md +++ /dev/null @@ -1,169 +0,0 @@ -Space Wizards Development Wiki -===================== - -[The Robust Book](index.md) - -Meta -==== - ----------------------- - -- [Guide to Editing Docs](en/meta/guide-to-editing-docs.md) -- [Docs Example Page](en/meta/docs-example-page.md) -- [Docs are for Discoverability](en/meta/docs-are-for-discoverability.md) - -General Development -=================== - ----------------------- - -- [Setup](en/general-development/setup.md) - - [How do I code?](en/general-development/setup/howdoicode.md) - - [Setting up a Development Environment](en/general-development/setup/setting-up-a-development-environment.md) - - [Git for the SS14 Developer](en/general-development/setup/git-for-the-ss14-developer.md) - - [Server Hosting Tutorial](en/general-development/setup/server-hosting-tutorial.md) -- [Codebase Info](en/general-development/codebase-info.md) - - [Conventions](en/general-development/codebase-info/conventions.md) - - [Pull Request Guidelines](en/general-development/codebase-info/pull-request-guidelines.md) - - [Codebase Organization](en/general-development/codebase-info/codebase-organization.md) - - [Acronyms & Nomenclature](en/general-development/codebase-info/acronyms-and-nomenclature.md) -- [Tips](en/general-development/tips.md) - - [Troubleshooting FAQ](en/general-development/tips/troubleshooting-faq.md) - - [Debugging Tools](en/general-development/tips/debugging-tools.md) - - [PRs With Engine Changes](en/general-development/tips/prs-with-engine-changes.md) - - [Writing Guidebook Entries](en/general-development/tips/writing-guidebook-entries.md) - - [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) - - [Expected Team Decorum & Usage](en/general-development/feature-proposals/expected-feature-proposal-decorum.md) - - [Fundamental Design Principles](en/general-development/feature-proposals/ss14-fundamental-design-principles.md) - - -SS14 By Example -=============== - ----------------------- - -- [Introduction to SS14 By Example](en/ss14-by-example/introduction-to-ss14-by-example.md) -- [Adding a Simple Bikehorn](en/ss14-by-example/adding-a-simple-bikehorn.md) -- [Making a Sprite Dynamic](en/ss14-by-example/making-a-sprite-dynamic.md) - - [Porting Appearance Visualizers](en/ss14-by-example/making-a-sprite-dynamic/porting-appearance-visualizers.md) -- [Basic Networking and You](en/ss14-by-example/basic-networking-and-you.md) -- [Fluent and Localization](en/ss14-by-example/fluent-and-localization.md) -- [UI Survival Guide](en/ss14-by-example/ui-survival-guide.md) - - -Robust Toolbox -============== - ----------------------- - -- [ECS](en/robust-toolbox/ecs.md) -- [Netcode]() - - [Net Entities](en/robust-toolbox/netcode/net-entities.md) - - [Potentially Visible Set]() -- [Coordinate Systems](en/robust-toolbox/coordinate-systems.md) -- [Transform]() - - [Entity Coordinates](en/robust-toolbox/transform/entity-coordinates.md) - - [Physics](en/robust-toolbox/transform/physics.md) - - [Grids](en/robust-toolbox/transform/grids.md) -- [Toolshed](en/robust-toolbox/toolshed.md) - - [Types](en/robust-toolbox/toolshed/types.md) - - [Toolshed and (S)CSI](en/robust-toolbox/toolshed/toolshed-and-scsi.md) - - [Environments](en/robust-toolbox/toolshed/environments.md) - - [Invocation contexts](en/robust-toolbox/toolshed/invocation-contexts.md) - - [Commands](en/robust-toolbox/toolshed/commands.md) - - [Entities](en/robust-toolbox/toolshed/commands/entity-control.md) - - [General](en/robust-toolbox/toolshed/commands/general.md) - - [Miscellaneous](en/robust-toolbox/toolshed/commands/misc.md) -- [User Interface](en/robust-toolbox/user-interface.md) -- [IoC](en/robust-toolbox/ioc.md) -- [Rendering]() - - [Lighting and FoV](en/robust-toolbox/rendering/lighting-and-fov.md) - - [Shaders](en/robust-toolbox/rendering/shaders.md) - - [Sprites and Icons](en/robust-toolbox/rendering/sprites-and-icons.md) -- [Serialization](en/robust-toolbox/serialization.md) -- [Sandboxing](en/robust-toolbox/sandboxing.md) -- [Content Manifests](en/robust-toolbox/content-manifests.md) -- [User Data Directory](en/robust-toolbox/user-data-directory.md) -- [Robust Modules](en/robust-toolbox/robust-modules.md) -- [Server HTTP API](en/robust-toolbox/server-http-api.md) -- [Build Configurations](en/robust-toolbox/build-configurations.md) -- [Preprocessor Defines](en/robust-toolbox/preprocessor-defines.md) -- [MIDI](en/robust-toolbox/midi.md) - -Space Station 14 -================ - ----------------------- - -- [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 -================ - ----------------------- - -Server Hosting -============== - ----------------------- - -- [Port Forwarding](en/server-hosting/port-forwarding.md) -- [Server Replay Recording](en/server-hosting/server-replay-recording.md) -- [Setting up Robust.Cdn](en/server-hosting/setting-up-robust-cdn.md) -- [Setting up SS14.Admin](en/server-hosting/setting-up-ss14-admin.md) -- [Setting up SS14.Changelog](en/server-hosting/setting-up-ss14-changelog.md) -- [Setting up SS14.Watchdog](en/server-hosting/setting-up-ss14-watchdog.md) -- [OAuth](en/server-hosting/oauth.md) - -Other Projects -============== - ----------------------- - -- [Launcher]() - - [Content Bundles](en/other-projects/launcher/content-bundles.md) - - [Delta Updates & Manifests](en/other-projects/launcher/delta-updates-and-manifests.md) -- [SpaceWizards Lidgren]() - -Specifications -============== - ----------------------- - -- [Robust Station Image](en/specifications/robust-station-image.md) -- [Robust Generic Attribution](en/specifications/robust-generic-attribution.md) - -Community -======================== - ----------------------- - -- [Infrastructure References](en/community/infrastructure-references.md) - - [Wizards Den Infrastructure](en/community/infrastructure-reference/wizards-den-infrastructure.md) - - [Publishing Scripts](en/community/infrastructure-reference/publishing-scripts.md) - - [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) -- [Discord Rich Presence Repository](en/community/discord-rich-presence-repository.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) - - [Wizards Den Admin Policy](en/community/admin/wizards-den-admin-policy.md) - - [Wizards Den Banning Policy](en/community/admin/wizards-den-banning-policy.md) diff --git a/src/en/SUMMARY.md b/src/en/SUMMARY.md new file mode 100644 index 000000000..3889eb097 --- /dev/null +++ b/src/en/SUMMARY.md @@ -0,0 +1,169 @@ +Space Wizards Development Wiki +===================== + +[The Robust Book](index.md) + +Meta +==== + +---------------------- + +- [Guide to Editing Docs](meta/guide-to-editing-docs.md) +- [Docs Example Page](meta/docs-example-page.md) +- [Docs are for Discoverability](meta/docs-are-for-discoverability.md) + +General Development +=================== + +---------------------- + +- [Setup](general-development/setup.md) + - [How do I code?](general-development/setup/howdoicode.md) + - [Setting up a Development Environment](general-development/setup/setting-up-a-development-environment.md) + - [Git for the SS14 Developer](general-development/setup/git-for-the-ss14-developer.md) + - [Server Hosting Tutorial](general-development/setup/server-hosting-tutorial.md) +- [Codebase Info](general-development/codebase-info.md) + - [Conventions](general-development/codebase-info/conventions.md) + - [Pull Request Guidelines](general-development/codebase-info/pull-request-guidelines.md) + - [Codebase Organization](general-development/codebase-info/codebase-organization.md) + - [Acronyms & Nomenclature](general-development/codebase-info/acronyms-and-nomenclature.md) +- [Tips](general-development/tips.md) + - [Troubleshooting FAQ](general-development/tips/troubleshooting-faq.md) + - [Debugging Tools](general-development/tips/debugging-tools.md) + - [PRs With Engine Changes](general-development/tips/prs-with-engine-changes.md) + - [Writing Guidebook Entries](general-development/tips/writing-guidebook-entries.md) + - [Config File Reference](general-development/tips/config-file-reference.md) + - [YAML Crash Course](general-development/tips/yaml-crash-course.md) +- [Feature Proposals](general-development/feature-proposals.md) + - [Expected Team Decorum & Usage](general-development/feature-proposals/expected-feature-proposal-decorum.md) + - [Fundamental Design Principles](general-development/feature-proposals/ss14-fundamental-design-principles.md) + + +SS14 By Example +=============== + +---------------------- + +- [Introduction to SS14 By Example](ss14-by-example/introduction-to-ss14-by-example.md) +- [Adding a Simple Bikehorn](ss14-by-example/adding-a-simple-bikehorn.md) +- [Making a Sprite Dynamic](ss14-by-example/making-a-sprite-dynamic.md) + - [Porting Appearance Visualizers](ss14-by-example/making-a-sprite-dynamic/porting-appearance-visualizers.md) +- [Basic Networking and You](ss14-by-example/basic-networking-and-you.md) +- [Fluent and Localization](ss14-by-example/fluent-and-localization.md) +- [UI Survival Guide](ss14-by-example/ui-survival-guide.md) + + +Robust Toolbox +============== + +---------------------- + +- [ECS](robust-toolbox/ecs.md) +- [Netcode]() + - [Net Entities](robust-toolbox/netcode/net-entities.md) + - [Potentially Visible Set]() +- [Coordinate Systems](robust-toolbox/coordinate-systems.md) +- [Transform]() + - [Entity Coordinates](robust-toolbox/transform/entity-coordinates.md) + - [Physics](robust-toolbox/transform/physics.md) + - [Grids](robust-toolbox/transform/grids.md) +- [Toolshed](robust-toolbox/toolshed.md) + - [Types](robust-toolbox/toolshed/types.md) + - [Toolshed and (S)CSI](robust-toolbox/toolshed/toolshed-and-scsi.md) + - [Environments](robust-toolbox/toolshed/environments.md) + - [Invocation contexts](robust-toolbox/toolshed/invocation-contexts.md) + - [Commands](robust-toolbox/toolshed/commands.md) + - [Entities](robust-toolbox/toolshed/commands/entity-control.md) + - [General](robust-toolbox/toolshed/commands/general.md) + - [Miscellaneous](robust-toolbox/toolshed/commands/misc.md) +- [User Interface](robust-toolbox/user-interface.md) +- [IoC](robust-toolbox/ioc.md) +- [Rendering]() + - [Lighting and FoV](robust-toolbox/rendering/lighting-and-fov.md) + - [Shaders](robust-toolbox/rendering/shaders.md) + - [Sprites and Icons](robust-toolbox/rendering/sprites-and-icons.md) +- [Serialization](robust-toolbox/serialization.md) +- [Sandboxing](robust-toolbox/sandboxing.md) +- [Content Manifests](robust-toolbox/content-manifests.md) +- [User Data Directory](robust-toolbox/user-data-directory.md) +- [Robust Modules](robust-toolbox/robust-modules.md) +- [Server HTTP API](robust-toolbox/server-http-api.md) +- [Build Configurations](robust-toolbox/build-configurations.md) +- [Preprocessor Defines](robust-toolbox/preprocessor-defines.md) +- [MIDI](robust-toolbox/midi.md) + +Space Station 14 +================ + +---------------------- + +- [Mapping](space-station-14/mapping.md) + - [Mapping Checklist](space-station-14/mapping/mapping-checklist.md) + - [Mapping Sins](space-station-14/mapping/mapping-sins.md) +- [Chemistry](space-station-14/chemistry.md) + - [Solution Containers](space-station-14/chemistry/solution-containers.md) + - [Reagents](space-station-14/chemistry/reagents.md) + - [Metabolism](space-station-14/chemistry/metabolism.md) + - [Reactions](space-station-14/chemistry/reactions.md) +- [Construction](space-station-14/construction.md) +- [Destructible](space-station-14/destructible.md) +- [Device Network](space-station-14/device-network.md) +- [Pow3r](space-station-14/pow3r.md) +- [Cartridge Loaders](space-station-14/cartridge-loaders.md) +- [Node Networks](space-station-14/node-networks.md) +- [Dungeons](space-station-14/dungeons.md) +- [NPCs](space-station-14/npcs.md) + +Design Proposals +================ + +---------------------- + +Server Hosting +============== + +---------------------- + +- [Port Forwarding](server-hosting/port-forwarding.md) +- [Server Replay Recording](server-hosting/server-replay-recording.md) +- [Setting up Robust.Cdn](server-hosting/setting-up-robust-cdn.md) +- [Setting up SS14.Admin](server-hosting/setting-up-ss14-admin.md) +- [Setting up SS14.Changelog](server-hosting/setting-up-ss14-changelog.md) +- [Setting up SS14.Watchdog](server-hosting/setting-up-ss14-watchdog.md) +- [OAuth](server-hosting/oauth.md) + +Other Projects +============== + +---------------------- + +- [Launcher]() + - [Content Bundles](other-projects/launcher/content-bundles.md) + - [Delta Updates & Manifests](other-projects/launcher/delta-updates-and-manifests.md) +- [SpaceWizards Lidgren]() + +Specifications +============== + +---------------------- + +- [Robust Station Image](specifications/robust-station-image.md) +- [Robust Generic Attribution](specifications/robust-generic-attribution.md) + +Community +========= + +---------------------- + +- [Infrastructure References](community/infrastructure-references.md) + - [Wizards Den Infrastructure](community/infrastructure-reference/wizards-den-infrastructure.md) + - [Publishing Scripts](community/infrastructure-reference/publishing-scripts.md) + - [Grafana Dashboards](community/infrastructure-reference/grafana-dashboards.md) +- [Space Wizards Hub Rules](community/space-wizards-hub-rules.md) +- [Space Wizards Role Hierarchy](community/space-wizards-role-hierarchy.md) +- [Discord Rich Presence Repository](community/discord-rich-presence-repository.md) +- [Admin](community/admin.md) + - [Admin Tooling](community/admin/admin-tooling.md) + - [Admin Command Cookbook](community/admin/admin-tooling/admin-command-cookbook.md) + - [Wizards Den Admin Policy](community/admin/wizards-den-admin-policy.md) + - [Wizards Den Banning Policy](community/admin/wizards-den-banning-policy.md) diff --git a/src/index.md b/src/en/index.md similarity index 100% rename from src/index.md rename to src/en/index.md diff --git a/src/en/meta/guide-to-editing-docs.md b/src/en/meta/guide-to-editing-docs.md index 0a32ffeac..6ee1aaac7 100644 --- a/src/en/meta/guide-to-editing-docs.md +++ b/src/en/meta/guide-to-editing-docs.md @@ -30,15 +30,23 @@ If you just want to make a basic edit of a page, simply follow these steps--you If you want to locally build the docs, the necessary dependencies are Rust and some binaries installed using `cargo`. It's recommended that you use `cargo binstall` or `cargo quickinstall`, as building can take a while. +You will need our fork of `mdbook`, called `mdbook-spacewizards`. You can install it like this: + +``` +cargo install --git https://github.com/space-wizards/mdBook-spacewizards +``` + +Binaries are also available on the releases page on GitHub. + From cargo, install: -- `mdbook` - `mdbook-mermaid` - `mdbook-template` - `mdbook-linkcheck` - `mdbook-admonish` - `mdbook-emojicodes` -Call `mdbook serve` to build and locally host the documentation from the `book` directory at `localhost:3000`. + +Call `mdbook-spacewizards serve` to build and locally host the documentation from the `book` directory at `localhost:3000`. ## Porting pages from Wiki.js diff --git a/src/ru/SUMMARY.md b/src/ru/SUMMARY.md new file mode 100644 index 000000000..e8ad2b8de --- /dev/null +++ b/src/ru/SUMMARY.md @@ -0,0 +1,54 @@ +Space Wizards Development Wiki +============================== + +[The Robust Book](index.md) + +Meta +==== + +---------------------- + +General Development +=================== + +---------------------- + +SS14 By Example +=============== + +---------------------- + +Robust Toolbox +============== + +---------------------- + +Space Station 14 +================ + +---------------------- + +Design Proposals +================ + +---------------------- + +Server Hosting +============== + +---------------------- + +Other Projects +============== + +---------------------- + +Specifications +============== + +---------------------- + +Community +========= + +---------------------- \ No newline at end of file diff --git a/src/ru/index.md b/src/ru/index.md new file mode 100644 index 000000000..5126c1a42 --- /dev/null +++ b/src/ru/index.md @@ -0,0 +1 @@ +# RU Index \ No newline at end of file