From bf6366cef4ce45ccd7f73d0c612cf81da6080624 Mon Sep 17 00:00:00 2001 From: Martin Fournier Date: Wed, 26 Jan 2022 05:13:38 -0500 Subject: [PATCH] Move markdown doc & quotes to ./docs subfolder --- README.md | 6 +++--- BN14.md => doc/BN14.md | 0 CONTRIBUTING.md => doc/CONTRIBUTING.md | 2 +- FAQ.md => doc/FAQ.md | 0 Quotes.txt => doc/Quotes.txt | 0 doc/source/gamefrozen.rst | 2 +- src/Themes/README.md | 2 +- 7 files changed, 6 insertions(+), 6 deletions(-) rename BN14.md => doc/BN14.md (100%) rename CONTRIBUTING.md => doc/CONTRIBUTING.md (97%) rename FAQ.md => doc/FAQ.md (100%) rename Quotes.txt => doc/Quotes.txt (100%) diff --git a/README.md b/README.md index 9a239435b..0401f18f6 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ Bitburner is a programming-based [incremental game](https://en.wikipedia.org/wik that revolves around hacking and cyberpunk themes. The game can be played at https://danielyxie.github.io/bitburner or installed through [Steam](https://store.steampowered.com/app/1812820/Bitburner/). -See the [frequently asked questions](./FAQ.md) for more information . To discuss the game or get help, join the [official discord server](https://discord.gg/TFc3hKD) +See the [frequently asked questions](./doc/FAQ.md) for more information . To discuss the game or get help, join the [official discord server](https://discord.gg/TFc3hKD) # Documentation @@ -18,13 +18,13 @@ The [in-game documentation](./markdown/bitburner.md) is generated from the [Type Anyone is welcome to contribute to the documentation by editing the [source files](/doc/source) and then making a pull request with your contributions. For further guidance, please refer to the "As A Documentor" section of -[CONTRIBUTING](CONTRIBUTING.md). +[CONTRIBUTING](./doc/CONTRIBUTING.md). # Contribution There are many ways to contribute to the game. It can be as simple as fixing a typo, correcting a bug, or improving the UI. For guidance on doing so, -please refer to the [CONTRIBUTING](CONTRIBUTING.md) document. +please refer to the [CONTRIBUTING](./doc/CONTRIBUTING.md) document. You will retain all ownership of the Copyright of any contributions you make, and will have the same rights to use or license your contributions. By diff --git a/BN14.md b/doc/BN14.md similarity index 100% rename from BN14.md rename to doc/BN14.md diff --git a/CONTRIBUTING.md b/doc/CONTRIBUTING.md similarity index 97% rename from CONTRIBUTING.md rename to doc/CONTRIBUTING.md index a6cfd9dbd..71ec878f8 100644 --- a/CONTRIBUTING.md +++ b/doc/CONTRIBUTING.md @@ -182,7 +182,7 @@ To contribute to and view your changes to the BitBurner documentation on [Read T Docs](http://bitburner.readthedocs.io/), you will need to have Python installed, along with [Sphinx](http://www.sphinx-doc.org). -To make change to the [in-game documentation](./markdown/bitburner.md), you will need to modify the [TypeScript definitions](./src/ScriptEditor/NetscriptDefinitions.d.ts), not the markdown files. +To make change to the [in-game documentation](../markdown/bitburner.md), you will need to modify the [TypeScript definitions](../src/ScriptEditor/NetscriptDefinitions.d.ts), not the markdown files. We are using [API Extractor](https://api-extractor.com/pages/tsdoc/doc_comment_syntax/) (tsdoc hints) to generate the markdown doc. Make your changes to the TypeScript definitions and then run `npm run doc`. diff --git a/FAQ.md b/doc/FAQ.md similarity index 100% rename from FAQ.md rename to doc/FAQ.md diff --git a/Quotes.txt b/doc/Quotes.txt similarity index 100% rename from Quotes.txt rename to doc/Quotes.txt diff --git a/doc/source/gamefrozen.rst b/doc/source/gamefrozen.rst index 7b29bb448..03876ae09 100644 --- a/doc/source/gamefrozen.rst +++ b/doc/source/gamefrozen.rst @@ -23,4 +23,4 @@ Bug --- Otherwise, the game is probably frozen/stuck due to a bug. To report a bug, follow -the guidelines `here `_. +the guidelines `here `_. diff --git a/src/Themes/README.md b/src/Themes/README.md index 3dffe710d..160d75e05 100644 --- a/src/Themes/README.md +++ b/src/Themes/README.md @@ -2,7 +2,7 @@ Feel free to contribute a new theme by submitting a pull request to the game! -See [CONTRIBUTING.md](/CONTRIBUTING.md) for details. +See [CONTRIBUTING.md](/doc/CONTRIBUTING.md) for details. ## How create a new theme