DOCUMENTATION: Clean up "doc" folder (#2427)

src/Documentation/doc/en/help/beginner_faq.md

@@ -1,39 +0,0 @@
-# FAQs for beginners
-
-This page is dedicated for questions often asked by beginners as they explore the game.
-
-The following are advice, as this is a single-player game. However you are free to experiment to see what works best for you.
-
-#### How do I create directories/folders?
-
-These are just a part of the filename. There is no explicit command to create them, rather files with the same prepending "directory" string are bundled together.
-
-#### Should I backdoor all servers?
-
-Short answer:
-Time-consuming for minimal benefits.
-
-Long answer:
-Backdooring a server takes a certain amount of time, and the duration is dependent on your hacking level and the given server's at the time of sending backdoor command.
-
-Given the amount of servers in the network and how often you have to do so after installing augments, it is ill-advised to perform such potentially lengthy tasks unnecessarily.
-
-#### How do I backdoor through scripts?
-
-It is only possible with an endgame ability, or via exploits.
-
-#### Should I target multiple servers or just one?
-
-[EHTs (Early Hacking Templates)](../programming/hackingalgorithms.md) can somewhat benefit from this at very late stages of the game where the player's hacking level is so high a few threads of `ns.hack()` can take all money of even strongest servers within the network.
-
-However, targetting multiple servers is not viable for batchers in particular due to the fact such algorithms do not suffer from over-hacking (a loose term that describes a targeted server being drained of all reserved money).
-
-#### What are the differences between threads and processes?
-
-When you run a script, you spawn a "process" that runs your code. With each process, you can specify a number of threads (default to 1).
-
-"Thread" is simply a multiplier applied to the effect of some actions (e.g., hack, grow, weaken). Using more threads multiplies the effect, but it also multiplies the RAM cost of running the script.
-
-#### Do in-game threads/processes have anything to do with the real life computer threads/processes?
-
-No, in fact the game is run in JavaScript which is single-threaded.

src/Documentation/doc/en/help/faq.md

@@ -0,0 +1,134 @@
+# Frequently Asked Questions
+
+## Beginner questions
+
+### How do I create directories/folders?
+
+These are just a part of the filename. There is no explicit command to create them, rather files with the same prepending "directory" string are bundled together.
+
+---
+
+### Should I backdoor all servers?
+
+Short answer:
+Time-consuming for minimal benefits.
+
+Long answer:
+Backdooring a server takes a certain amount of time, and the duration is dependent on your hacking level and the given server's at the time of sending backdoor command.
+
+Given the amount of servers in the network and how often you have to do so after installing augments, it is ill-advised to perform such potentially lengthy tasks unnecessarily.
+
+---
+
+### How do I backdoor through scripts?
+
+It is only possible with an endgame ability, or via exploits.
+
+---
+
+### Should I target multiple servers or just one?
+
+[EHTs (Early Hacking Templates)](../programming/hackingalgorithms.md) can somewhat benefit from this at very late stages of the game where the player's hacking level is so high a few threads of `ns.hack()` can take all money of even strongest servers within the network.
+
+However, targeting multiple servers is not viable for batchers in particular due to the fact such algorithms do not suffer from over-hacking (a loose term that describes a targeted server being drained of all reserved money).
+
+---
+
+### What are the differences between threads and processes?
+
+When you run a script, you spawn a "process" that runs your code. With each process, you can specify a number of threads (default to 1).
+
+"Thread" is simply a multiplier applied to the effect of some actions (e.g., hack, grow, weaken). Using more threads multiplies the effect, but it also multiplies the RAM cost of running the script.
+
+---
+
+### Do in-game threads/processes have anything to do with the real life computer threads/processes?
+
+No, in fact the game is run in JavaScript which is single-threaded.
+
+---
+
+## General questions
+
+### Can I donate to the project?
+
+No, the project does not take donations.
+
+If you still want to donate, go donate blood to your local blood bank or donate to the [Electronic Frontier Foundation](https://www.eff.org/) or [Médecins Sans Frontières](https://www.msf.org/)
+
+---
+
+### I need help / Where can I learn?
+
+The best way to get help is to join the [official discord server](https://discord.gg/TFc3hKD). People of all skill levels will be able to give you hints and tips.
+
+---
+
+### Can I play the same save on browser & steam?
+
+Yes, just export the save file from the options menu & import it in the other platform.
+
+---
+
+### Game is stuck after running scripts!
+
+You may have created an infinite loop with no sleep. You'll have to restart the game by killing all scripts.
+
+- On Browser: Stick `?noScript` at the end of the URL
+- On Steam:
+  - In the menu, "Reloads" -> "Reload & Kill All Scripts".
+  - If this does not work, when launching the game, use the kill all scripts option.
+
+---
+
+### Steam: Where is the save game located?
+
+To maintain compatibility with the web browser version, the save game is not stored as a file on your filesystem. It lives inside the localStorage of the WebKit instance. Export the save (and back it up!) in the option menu.
+
+---
+
+### Steam: Game won't stop / Game is shown as "Running"
+
+Due to a limitation with the way Steam tracks the game, if you launch an external link (such as documentation), Steam may keep tracking the game as "Running" even after it is closed. Simply close the web browser to fix this.
+
+---
+
+### Steam: How do I get to the game files?
+
+Right-click the game in your Steam library, then go into "Manage" -> "Browse Local Files". The game can be launched directly from that location if you're having issues with Steam.
+
+---
+
+### Steam: Game won't launch
+
+#### **On Windows**
+
+If the game is installed on a network drive, it will fail to start due to a [limitation in Chromium](https://github.com/electron/electron/issues/27356).
+
+If you cannot move the game to another drive, you'll have to add `--no-sandbox` to the launch options. In your Steam Library, right click the game and hit "Properties". You'll see the "launch options" section in the "General" window.
+
+#### **On Linux**
+
+The game is built natively. Do not use Proton unless native does not work.
+
+When launching the game, you will be prompted with three options. If the standard launch does not work, you may attempt the `--disable-seccomp-filter-sandbox` or `--no-sandbox` launch options. If this still does not work, the game should be able to start by launching it directly or through the terminal. See "How do I get to the game files?".
+
+---
+
+### Steam: File locations
+
+#### Logs (using [electron-log](https://github.com/megahertz/electron-log#readme))
+
+You may want to access the logs to get information about crashes and such.
+
+- on Linux: `~/.config/bitburner/logs/main.log`
+- on macOS: `~/Library/Logs/bitburner/main.log`
+- on Windows: `%USERPROFILE%\AppData\Roaming\bitburner\logs\main.log`
+
+#### Config (using [electron-store](https://github.com/sindresorhus/electron-store#readme))
+
+Configuration files can be found in the application's data directory.
+
+- on Linux: `~/.config/bitburner/config.json`
+- on macOS: `~/Library/Application\ Support/bitburner/config.json`
+- on Windows: `%USERPROFILE%\AppData\Roaming\bitburner\config.json`

src/Documentation/doc/en/index.md

@@ -52,7 +52,7 @@
 - [Game frozen or stuck?](programming/game_frozen.md)
 - [TypeScript and React](programming/typescript_react.md)
 - [Tools & Resources](help/tools_and_resources.md)
-- [FAQs for beginners](help/beginner_faq.md)
+- [FAQ](help/faq.md)
 - [Changelog](changelog.md)
 - [Changelog - Legacy v1](changelog-v1.md)
 - [Changelog - Legacy v0](changelog-v0.md)

src/Documentation/pages.ts

@@ -51,7 +51,7 @@ import file48 from "./doc/en/basic/world.md?raw";
 import file49 from "./doc/en/changelog-v0.md?raw";
 import file50 from "./doc/en/changelog-v1.md?raw";
 import file51 from "./doc/en/changelog.md?raw";
-import file52 from "./doc/en/help/beginner_faq.md?raw";
+import file52 from "./doc/en/help/faq.md?raw";
 import file53 from "./doc/en/help/getting_started.md?raw";
 import file54 from "./doc/en/help/tools_and_resources.md?raw";
 import file55 from "./doc/en/index.md?raw";
@@ -1561,7 +1561,7 @@ AllPages["en/basic/world.md"] = file48;
 AllPages["en/changelog-v0.md"] = file49;
 AllPages["en/changelog-v1.md"] = file50;
 AllPages["en/changelog.md"] = file51;
-AllPages["en/help/beginner_faq.md"] = file52;
+AllPages["en/help/faq.md"] = file52;
 AllPages["en/help/getting_started.md"] = file53;
 AllPages["en/help/tools_and_resources.md"] = file54;
 AllPages["en/index.md"] = file55;