Port the Design Document to MkDocs, following GitBook's decision to stop allowing self-hosting.
This commit is contained in:
parent
ffd470c0f7
commit
090add7098
6
.gitignore
vendored
6
.gitignore
vendored
@ -1,6 +1,4 @@
|
|||||||
trac
|
venv
|
||||||
output
|
site
|
||||||
_book
|
|
||||||
node_modules
|
|
||||||
|
|
||||||
*.orig
|
*.orig
|
||||||
|
|||||||
34
README.md
34
README.md
@ -1,5 +1,29 @@
|
|||||||
Build the Design Document using GitBook:
|
# Contributing
|
||||||
```
|
|
||||||
npm install gitbook-cli -g
|
Contributing to the Design Document is possible for everyone, and is in many
|
||||||
gitbook build
|
ways similar to contributing to the game. We want the contributions to be
|
||||||
```
|
easy to perform and easy to review. In the future, we will look for a person
|
||||||
|
able to manage the evolution of this document, and the quality of contributions
|
||||||
|
and interactions with the reviewers will be a decisive factor in the choice
|
||||||
|
of the person.
|
||||||
|
|
||||||
|
Contributing is done by submitting a pull request to the DD repository.
|
||||||
|
NB: Update this part when this becomes official, in order to use the correct
|
||||||
|
vocabulary for the Phabricator workflow etc.
|
||||||
|
|
||||||
|
Small contributions, for fixing typos or style, will be accepted. Copy-pasting
|
||||||
|
from a former version of the document or from other sources (see
|
||||||
|
[Links and References](book/links.md)) will be accepted if a link to the source is
|
||||||
|
provided in the commit message.
|
||||||
|
|
||||||
|
Bigger contributions, like proposals of a new feature, will be reviewed if
|
||||||
|
they come with a proof-of-concept that allows us to test the proposal. It can
|
||||||
|
be a patch, a mod, an edited image, etc. The proof-of-concept does not need
|
||||||
|
to be committable to the game source repository, it only needs to display
|
||||||
|
accurately the feature proposal. Please be aware that those contributions will
|
||||||
|
be more difficult to review and might need lengthy discussions and refinements.
|
||||||
|
|
||||||
|
# Building the DD
|
||||||
|
Build the Design Document using MkDocs:
|
||||||
|
- Install the tool with `pip install mkdocs` in a virtualenv or globally.
|
||||||
|
- Build the DD with `mkdocs build`
|
||||||
|
|||||||
@ -1,9 +0,0 @@
|
|||||||
{
|
|
||||||
"root": "book/",
|
|
||||||
"title": "0 A.D. Design Document",
|
|
||||||
"author": "Wildfire Games",
|
|
||||||
"plugins": [
|
|
||||||
"-sharing",
|
|
||||||
"alerts",
|
|
||||||
"creativecommons"]
|
|
||||||
}
|
|
||||||
@ -1,25 +0,0 @@
|
|||||||
Contributing
|
|
||||||
============
|
|
||||||
|
|
||||||
Contributing to the Design Document is possible for everyone, and is in many
|
|
||||||
ways similar to contributing to the game. We want the contributions to be
|
|
||||||
easy to perform and easy to review. In the future, we will look for a person
|
|
||||||
able to manage the evolution of this document, and the quality of contributions
|
|
||||||
and interactions with the reviewers will be a decisive factor in the choice
|
|
||||||
of the person.
|
|
||||||
|
|
||||||
Contributing is done by submitting a pull request to the DD repository.
|
|
||||||
NB: Update this part when this becomes official, in order to use the correct
|
|
||||||
vocabulary for the Phabricator workflow etc.
|
|
||||||
|
|
||||||
Small contributions, for fixing typos or style, will be accepted. Copy-pasting
|
|
||||||
from a former version of the document or from other sources (see
|
|
||||||
[Links and References](LINKS.md)) will be accepted if a link to the source is
|
|
||||||
provided in the commit message.
|
|
||||||
|
|
||||||
Bigger contributions, like proposals of a new feature, will be reviewed if
|
|
||||||
they come with a proof-of-concept that allows us to test the proposal. It can
|
|
||||||
be a patch, a mod, an edited image, etc. The proof-of-concept does not need
|
|
||||||
to be committable to the game source repository, it only needs to display
|
|
||||||
accurately the feature proposal. Please be aware that those contributions will
|
|
||||||
be more difficult to review and might need lengthy discussions and refinements.
|
|
||||||
@ -1,15 +0,0 @@
|
|||||||
Links and References
|
|
||||||
====================
|
|
||||||
|
|
||||||
This Design Document is still a work in progress and is based on several
|
|
||||||
iterations of the text, as well as scattered information across our
|
|
||||||
development forums, wiki, etc.
|
|
||||||
|
|
||||||
Here is a collection of a few references that might be useful for the
|
|
||||||
contributor or the reader who is curious about the origins of the document.
|
|
||||||
|
|
||||||
* Our Trac wiki: https://trac.wildfiregames.com
|
|
||||||
* [Previous version of the DD](https://trac.wildfiregames.com/wiki/Design_Document)
|
|
||||||
* [Attempt at an update](https://trac.wildfiregames.com/wiki/DDv3WIP)
|
|
||||||
* [Exhaustive list of all pages of the wiki](https://trac.wildfiregames.com/wiki/TitleIndex)
|
|
||||||
* Our forums: https://wildfiregames.com/forum
|
|
||||||
@ -1,8 +0,0 @@
|
|||||||
# 0 A.D. Design Document
|
|
||||||
|
|
||||||
## Licensing and Disclaimer
|
|
||||||
|
|
||||||
{% creativecommons type="by-sa" %}
|
|
||||||
{% endcreativecommons %}
|
|
||||||
|
|
||||||
The info contained in this Design Document is provided as-is. It represents the current plan for 0 A.D. but the final game might not be exactly as described here due to for example issues found when balancing the game or features cut to make it possible to release the game in a reasonable time.
|
|
||||||
@ -1,35 +0,0 @@
|
|||||||
# Summary
|
|
||||||
|
|
||||||
* [0 A.D. Design Document](README.md)
|
|
||||||
|
|
||||||
* [Links and References](LINKS.md)
|
|
||||||
|
|
||||||
* [Contributing](CONTRIBUTING.md)
|
|
||||||
|
|
||||||
* [Gameplay Design](gameplay/README.md)
|
|
||||||
* Main concepts
|
|
||||||
* [0 A.D. - The Vision](gameplay/main/vision.md)
|
|
||||||
* [War Story](gameplay/main/war-story.md)
|
|
||||||
* [Territories](gameplay/main/territories.md)
|
|
||||||
* [Capturing](gameplay/main/capturing.md)
|
|
||||||
* [Formations](gameplay/main/formations.md)
|
|
||||||
* Elements
|
|
||||||
* [Maps](gameplay/elements/maps.md)
|
|
||||||
* [Structures](gameplay/elements/structures.md)
|
|
||||||
* [Entities](gameplay/elements/entities.md)
|
|
||||||
* Civilizations
|
|
||||||
* [Athenians](gameplay/civs/athenians.md)
|
|
||||||
* [Britons](gameplay/civs/britons.md)
|
|
||||||
* [Carthaginians](gameplay/civs/carthaginians.md)
|
|
||||||
* [Gauls](gameplay/civs/gauls.md)
|
|
||||||
* [Iberians](gameplay/civs/iberians.md)
|
|
||||||
* [Macedonians](gameplay/civs/macedonians.md)
|
|
||||||
* [Mauryans](gameplay/civs/mauryans.md)
|
|
||||||
* [Persians](gameplay/civs/persians.md)
|
|
||||||
* [Ptolemies](gameplay/civs/ptolemies.md)
|
|
||||||
* [Romans](gameplay/civs/romans.md)
|
|
||||||
* [Seleucids](gameplay/civs/seleucids.md)
|
|
||||||
* [Spartans](gameplay/civs/spartans.md)
|
|
||||||
* [Technical Design](technical/README.md)
|
|
||||||
* [General settings](technical/settings.md)
|
|
||||||
* [Game settings and setup](part2/gamesetup.md)
|
|
||||||
@ -1,10 +1,10 @@
|
|||||||
Formations
|
Formations
|
||||||
==========
|
==========
|
||||||
|
|
||||||
> **[danger] Implementation status**
|
!!! warning
|
||||||
>
|
|
||||||
> This page is a work in progress. Assume that nothing described here is
|
This page is a work in progress. Assume that nothing described here is
|
||||||
> finalised yet and everything could work completely different in the end.
|
finalised yet and everything could work completely different in the end.
|
||||||
|
|
||||||
# Current state and Goal
|
# Current state and Goal
|
||||||
|
|
||||||
|
|||||||
@ -1,10 +1,10 @@
|
|||||||
TERRITORIES
|
TERRITORIES
|
||||||
===========
|
===========
|
||||||
|
|
||||||
> **[warning] Implementation status**
|
!!! warning
|
||||||
>
|
|
||||||
> This page describes a feature that is implemented, but the implementation
|
This page describes a feature that is implemented, but the implementation
|
||||||
> significantly differs from the text here. The text is to be updated.
|
significantly differs from the text here. The text is to be updated.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
24
book/index.md
Normal file
24
book/index.md
Normal file
@ -0,0 +1,24 @@
|
|||||||
|
0 A.D. Design Document
|
||||||
|
======================
|
||||||
|
|
||||||
|
## Licensing and Disclaimer
|
||||||
|
|
||||||
|
[](https://creativecommons.org/licenses/by-sa/4.0/)
|
||||||
|
This work is licensed under a Creative Commons Attribution-ShareAlike 4.0 International License.
|
||||||
|
|
||||||
|
The info contained in this Design Document is provided as-is. It represents the current plan for 0 A.D. but the final game might not be exactly as described here due to for example issues found when balancing the game or features cut to make it possible to release the game in a reasonable time.
|
||||||
|
|
||||||
|
## Links and References
|
||||||
|
|
||||||
|
This Design Document is still a work in progress and is based on several
|
||||||
|
iterations of the text, as well as scattered information across our
|
||||||
|
development forums, wiki, etc.
|
||||||
|
|
||||||
|
Here is a collection of a few references that might be useful for the
|
||||||
|
contributor or the reader who is curious about the origins of the document.
|
||||||
|
|
||||||
|
* Our Trac wiki:
|
||||||
|
* [Previous version of the DD](https://trac.wildfiregames.com/wiki/Design_Document)
|
||||||
|
* [Attempt at an update](https://trac.wildfiregames.com/wiki/DDv3WIP)
|
||||||
|
* [Exhaustive list of all pages of the wiki](https://trac.wildfiregames.com/wiki/TitleIndex)
|
||||||
|
* [Our forums](https://wildfiregames.com/forum)
|
||||||
37
mkdocs.yml
Normal file
37
mkdocs.yml
Normal file
@ -0,0 +1,37 @@
|
|||||||
|
site_name: 0 A.D. Design Document
|
||||||
|
site_author: Wildfire Games
|
||||||
|
repo_url: https://code.wildfiregames.com/source/design/
|
||||||
|
repo_name: Contributing
|
||||||
|
use_directory_urls: false
|
||||||
|
|
||||||
|
docs_dir: book
|
||||||
|
markdown_extensions:
|
||||||
|
- admonition
|
||||||
|
|
||||||
|
nav:
|
||||||
|
- Gameplay - Main concepts:
|
||||||
|
- '0 A.D. The Vision': gameplay/main/vision.md
|
||||||
|
- 'War Story': gameplay/main/war-story.md
|
||||||
|
- 'Territories': gameplay/main/territories.md
|
||||||
|
- 'Capturing': gameplay/main/capturing.md
|
||||||
|
- 'Formations': gameplay/main/formations.md
|
||||||
|
- Gameplay Elements:
|
||||||
|
- 'Maps': gameplay/elements/maps.md
|
||||||
|
- 'Structures': gameplay/elements/structures.md
|
||||||
|
- 'Entities': gameplay/elements/entities.md
|
||||||
|
- Civilizations:
|
||||||
|
- 'Athenians': gameplay/civs/athenians.md
|
||||||
|
- 'Britons': gameplay/civs/britons.md
|
||||||
|
- 'Carthaginians': gameplay/civs/carthaginians.md
|
||||||
|
- 'Gauls': gameplay/civs/gauls.md
|
||||||
|
- 'Iberians': gameplay/civs/iberians.md
|
||||||
|
- 'Macedonians': gameplay/civs/macedonians.md
|
||||||
|
- 'Mauryans': gameplay/civs/mauryans.md
|
||||||
|
- 'Persians': gameplay/civs/persians.md
|
||||||
|
- 'Ptolemies': gameplay/civs/ptolemies.md
|
||||||
|
- 'Romans': gameplay/civs/romans.md
|
||||||
|
- 'Seleucids': gameplay/civs/seleucids.md
|
||||||
|
- 'Spartans': gameplay/civs/spartans.md
|
||||||
|
- Technical Design:
|
||||||
|
- 'General settings': technical/settings.md
|
||||||
|
- 'Game settings and setup': technical/gamesetup.md
|
||||||
Loading…
Reference in New Issue
Block a user