From ccb23bb9a8d400c471b05cc4bbd01aca5427b3c0 Mon Sep 17 00:00:00 2001 From: Nick Malaguti Date: Sun, 4 Dec 2016 13:33:47 -0500 Subject: [PATCH] Reorganize Halite Documentation Reorganize how Halite is documented and switch from using HTML to using Markdown. --- website/bot_overview.php | 32 +++ website/composer.json | 3 +- website/developing_a_bot.php | 38 +++ website/faqs.php | 32 +++ website/game_overview.php | 44 ++++ website/includes/dropdowns.php | 4 +- website/includes/learn_sidebar.php | 123 ++++++---- website/includes/prism_scripts.php | 6 + website/includes/prism_styles.php | 7 + website/install.sh | 6 +- website/learn/bot/a_bots_life.md | 48 ++++ .../local_development_environment.md | 114 +++++++++ website/learn/developing/submitting_a_bot.md | 66 +++++ website/learn/faqs.md | 52 ++++ website/learn/game/game_rules.md | 120 ++++++++++ website/learn/game/what_is_halite.md | 5 + website/learn/quickstart/dive_in.md | 63 +++++ website/learn/server/hardware.md | 21 ++ website/learn/server/software.md | 30 +++ .../learn/tournament/about_the_tournament.md | 34 +++ .../tutorials/improving_the_random_bot.md | 226 ++++++++++++++++++ website/quickstart.php | 32 +++ website/reference.php | 0 website/server_overview.php | 33 +++ website/tournament_overview.php | 32 +++ website/tutorials.php | 33 +++ 26 files changed, 1158 insertions(+), 46 deletions(-) create mode 100644 website/bot_overview.php create mode 100644 website/developing_a_bot.php create mode 100644 website/faqs.php create mode 100644 website/game_overview.php create mode 100644 website/includes/prism_scripts.php create mode 100644 website/includes/prism_styles.php create mode 100644 website/learn/bot/a_bots_life.md create mode 100644 website/learn/developing/local_development_environment.md create mode 100644 website/learn/developing/submitting_a_bot.md create mode 100644 website/learn/faqs.md create mode 100644 website/learn/game/game_rules.md create mode 100644 website/learn/game/what_is_halite.md create mode 100644 website/learn/quickstart/dive_in.md create mode 100644 website/learn/server/hardware.md create mode 100644 website/learn/server/software.md create mode 100644 website/learn/tournament/about_the_tournament.md create mode 100644 website/learn/tutorials/improving_the_random_bot.md create mode 100644 website/quickstart.php create mode 100644 website/reference.php create mode 100644 website/server_overview.php create mode 100644 website/tournament_overview.php create mode 100644 website/tutorials.php diff --git a/website/bot_overview.php b/website/bot_overview.php new file mode 100644 index 000000000..207010cc2 --- /dev/null +++ b/website/bot_overview.php @@ -0,0 +1,32 @@ + + + + + <?php echo ucwords(str_replace('_', ' ', basename(__FILE__, '.php'))); ?> + + + + + + + +
+ +
+ +
+

+ text(file_get_contents(__DIR__ . "/learn/bot/a_bots_life.md")); ?> +
+
+ +
+ + + + + + + + + diff --git a/website/composer.json b/website/composer.json index e8245069e..4383e9327 100644 --- a/website/composer.json +++ b/website/composer.json @@ -2,6 +2,7 @@ "require": { "lusitanian/oauth": "~0.3", "swiftmailer/swiftmailer": "^5.4.3", - "aws/aws-sdk-php": "^3.19" + "aws/aws-sdk-php": "^3.19", + "erusev/parsedown": "^1.6.1" } } diff --git a/website/developing_a_bot.php b/website/developing_a_bot.php new file mode 100644 index 000000000..1ddafa844 --- /dev/null +++ b/website/developing_a_bot.php @@ -0,0 +1,38 @@ + + + + + <?php echo ucwords(str_replace('_', ' ', basename(__FILE__, '.php'))); ?> + + + + + + + +
+ +
+ +
+

+ text(file_get_contents(__DIR__ . "/learn/developing/local_development_environment.md")); ?> + text(file_get_contents(__DIR__ . "/learn/developing/submitting_a_bot.md")); ?> +
+
+ +
+ + + + + + + + + + + + + + diff --git a/website/faqs.php b/website/faqs.php new file mode 100644 index 000000000..805f1346d --- /dev/null +++ b/website/faqs.php @@ -0,0 +1,32 @@ + + + + + <?php echo ucwords(str_replace('_', ' ', basename(__FILE__, '.php'))); ?> + + + + + + + +
+ +
+ +
+

FAQs

+ text(file_get_contents(__DIR__ . "/learn/faqs.md")); ?> +
+
+ +
+ + + + + + + + + diff --git a/website/game_overview.php b/website/game_overview.php new file mode 100644 index 000000000..b077a1f3d --- /dev/null +++ b/website/game_overview.php @@ -0,0 +1,44 @@ + + + + + <?php echo ucwords(str_replace('_', ' ', basename(__FILE__, '.php'))); ?> + + + + + + + + +
+ +
+ +
+

+ text(file_get_contents(__DIR__ . "/learn/game/what_is_halite.md")); ?> + text(file_get_contents(__DIR__ . "/learn/game/game_rules.md")); ?> +
+
+ +
+ + + + + + + + + + + + + + diff --git a/website/includes/dropdowns.php b/website/includes/dropdowns.php index 05daedc7d..4c8fdc17d 100644 --- a/website/includes/dropdowns.php +++ b/website/includes/dropdowns.php @@ -1,5 +1,5 @@
  • - Learn + Learn
  • Download @@ -15,4 +15,4 @@
  • About -
    • \ No newline at end of file + diff --git a/website/includes/learn_sidebar.php b/website/includes/learn_sidebar.php index 5e945e42b..339e3a607 100644 --- a/website/includes/learn_sidebar.php +++ b/website/includes/learn_sidebar.php @@ -25,19 +25,20 @@ } /* active & hover links */ - .bs-docs-sidebar .nav>.active>a, - .bs-docs-sidebar .nav>li>a:hover, + .bs-docs-sidebar .nav>.active>a, + .bs-docs-sidebar .nav>li>a:hover, .bs-docs-sidebar .nav>li>a:focus { - text-decoration: none; - background-color: transparent; + text-decoration: none; + background-color: transparent; + border-left-color: #63ceca; } /* nested active links */ - .bs-docs-sidebar .nav .nav>.active>a, + .bs-docs-sidebar .nav .nav>.active>a, .bs-docs-sidebar .nav .nav>.active:hover>a, .bs-docs-sidebar .nav .nav>.active:focus>a { font-weight: 700; - border-left-color: #63ceca; + border-left-color: #63ceca; font-weight: 500; } @@ -45,65 +46,85 @@