Skip to content

Commit

Permalink
Update README.md as we've moved away from wikijs for a long time at t…
Browse files Browse the repository at this point in the history
…his point
  • Loading branch information
mirrorcult authored May 31, 2024
1 parent 4fca465 commit 97edb34
Showing 1 changed file with 8 additions and 8 deletions.
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,14 @@
# 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
- Eventual localization support

The following `mdbook` features & plugins are available and in use:
Expand All @@ -18,8 +20,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

0 comments on commit 97edb34

Please sign in to comment.