mirror of
https://github.com/swarm-game/swarm.git
synced 2024-09-11 14:46:33 +03:00
4e886e0c3c
Closes #1436. The schema `.json` files are now the authoritative source of truth for documentation. Wrote a very simple parser for JsonSchema to extract the documentation from JSON. Split the README.md into [static](c314cc50a1/data/scenarios/README.md) and [auto-generated](c314cc50a1/data/scenarios/doc-fragments/SCHEMA.md) parts. Added a custom `"footers"` key to schema files to support inclusion of other markdown files for each object description. # Schema doc regeneration ./scripts/regenerate-schema-docs.sh
6 lines
187 B
Bash
Executable File
6 lines
187 B
Bash
Executable File
#!/bin/bash -e
|
|
|
|
SCRIPT_DIR=$( cd -- "$( dirname -- "${BASH_SOURCE[0]}" )" &> /dev/null && pwd )
|
|
cd $SCRIPT_DIR/..
|
|
|
|
stack build --fast && stack exec -- swarm generate cheatsheet --scenario |