mirror of
https://github.com/bitburner-official/bitburner-src.git
synced 2024-11-21 23:23:51 +01:00
Remove more rtd references (#702)
This commit is contained in:
parent
aed01b0979
commit
931d7e588a
@ -13,8 +13,7 @@ See the [frequently asked questions](./doc/FAQ.md) for more information . To dis
|
||||
|
||||
# Documentation
|
||||
|
||||
The game's official documentation can be found on [Read The
|
||||
Docs](http://bitburner-official.readthedocs.io/). Please note that this is still a work-in-progress.
|
||||
The game's official documentation can be found in-game.
|
||||
|
||||
The [in-game documentation](./markdown/bitburner.md) is generated from the [TypeScript definitions](./src/ScriptEditor/NetscriptDefinitions.d.ts).
|
||||
|
||||
|
@ -213,9 +213,8 @@ the following rules:
|
||||
|
||||
## As a Documenter
|
||||
|
||||
To contribute to and view your changes to the BitBurner documentation on [Read The
|
||||
Docs](http://bitburner.readthedocs.io/), you will
|
||||
need to have Python installed, along with [Sphinx](http://www.sphinx-doc.org).
|
||||
To contribute to and view your changes to the BitBurner documentation in-game, you will
|
||||
need to edit the files in [this folder](https://github.com/bitburner-official/bitburner-src/tree/dev/src/Documentation/doc)
|
||||
|
||||
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.
|
||||
|
||||
@ -230,8 +229,6 @@ rules:
|
||||
- Rebase your branch if necessary.
|
||||
- When submitting the pull request, make sure that the base fork is
|
||||
_bitburner-official/bitburner-src_ and the base is _dev_.
|
||||
- Do not check in any generated files under `doc\`. The documentation is built
|
||||
automatically by ReadTheDocs.
|
||||
|
||||
## Deploying a new version
|
||||
|
||||
|
@ -0,0 +1,3 @@
|
||||
# Corporations
|
||||
|
||||
PLACEHOLDER
|
@ -284,7 +284,7 @@ GRAFTING:
|
||||
DOCUMENTATION
|
||||
|
||||
- Many documentation updates (@Mughur, @d0sboots, @Snarling, @teauxfu).
|
||||
- Official non-markdown docs are at http://bitburner-official.readthedocs.io/
|
||||
- Official non-markdown docs are at https://github.com/bitburner-official/bitburner-src/tree/dev/src/Documentation/doc
|
||||
- Official dev version markdown docs are at https://github.com/bitburner-official/bitburner-src/blob/dev/markdown/bitburner.ns.md
|
||||
- Official stable version markdown docs are at https://github.com/bitburner-official/bitburner-src/blob/stable/markdown/bitburner.ns.md
|
||||
- Dev version documentation is now kept up to date as changes are made. (@Snarling)
|
||||
@ -1306,7 +1306,7 @@ Stanek Gift
|
||||
** Announcement **
|
||||
|
||||
- Several API breaks have been implemented.
|
||||
- See the v1.0.0 migration guide https://bitburner.readthedocs.io/en/latest/v1.0.0_migration.html
|
||||
- See the v1.0.0 migration guide under Documentation
|
||||
- Everyone gets 10 free neuroflux level.
|
||||
|
||||
** Netscript **
|
||||
@ -2685,8 +2685,6 @@ Stanek Gift
|
||||
|
||||
- Added a very rudimentary directory system to the Terminal
|
||||
|
||||
- Details here: https://bitburner.readthedocs.io/en/latest/basicgameplay/terminal.html#filesystem-directories
|
||||
|
||||
- Added numHashes(), hashCost(), and spendHashes() functions to the Netscript Hacknet Node API
|
||||
- 'Generate Coding Contract' hash upgrade is now more expensive
|
||||
- 'Generate Coding Contract' hash upgrade now generates the contract randomly on the server, rather than on home computer
|
||||
@ -3180,7 +3178,7 @@ Stanek Gift
|
||||
|
||||
## v0.37.0 - 5/20/2018
|
||||
|
||||
- NetscriptJS (Netscript 2.0) released (Documentation here: http://bitburner.readthedocs.io/en/latest/netscriptjs.html)
|
||||
- NetscriptJS (Netscript 2.0) released
|
||||
- Running the game with the '?noScripts' query will start the game without loading any of your scripts. This should be used if you accidentally write a script that crashes your game
|
||||
|
||||
## v0.36.1 - 5/11/2018
|
||||
|
@ -1,14 +1,4 @@
|
||||
import {
|
||||
BugReport,
|
||||
Chat,
|
||||
Download,
|
||||
LibraryBooks,
|
||||
Palette,
|
||||
Reddit,
|
||||
Save,
|
||||
SystemUpdateAlt,
|
||||
Upload,
|
||||
} from "@mui/icons-material";
|
||||
import { BugReport, Chat, Download, LibraryBooks, Palette, Reddit, Save, Upload } from "@mui/icons-material";
|
||||
import { Box, Button, List, ListItemButton, Paper, Tooltip, Typography } from "@mui/material";
|
||||
import { default as React, useRef, useState } from "react";
|
||||
import { FileDiagnosticModal } from "../../Diagnostic/FileDiagnosticModal";
|
||||
@ -239,7 +229,7 @@ export const GameOptionsSidebar = (props: IProps): React.ReactElement => {
|
||||
sx={{
|
||||
gridArea: "links",
|
||||
display: "grid",
|
||||
gridTemplateAreas: `"bug changelog"
|
||||
gridTemplateAreas: `"bug bug"
|
||||
"discord reddit"
|
||||
"tut tut"
|
||||
"plaza plaza"`,
|
||||
@ -255,14 +245,6 @@ export const GameOptionsSidebar = (props: IProps): React.ReactElement => {
|
||||
>
|
||||
Report Bug
|
||||
</Button>
|
||||
<Button
|
||||
startIcon={<SystemUpdateAlt />}
|
||||
href="https://bitburner-official.readthedocs.io/en/latest/changelog.html"
|
||||
target="_blank"
|
||||
sx={{ gridArea: " changelog" }}
|
||||
>
|
||||
Changelog
|
||||
</Button>
|
||||
<Button startIcon={<LibraryBooks />} onClick={() => setConfirmResetOpen(true)} sx={{ gridArea: "tut" }}>
|
||||
Reset tutorial
|
||||
</Button>
|
||||
|
@ -20,7 +20,10 @@ export const RemoteAPIPage = (): React.ReactElement => {
|
||||
text editor and then upload files to the home server.
|
||||
</Typography>
|
||||
<Typography>
|
||||
<Link href="https://bitburner-official.readthedocs.io/en/latest/remoteapi.html" target="_blank">
|
||||
<Link
|
||||
href="https://github.com/bitburner-official/bitburner-src/blob/dev/src/Documentation/doc/programming/remote_api.md"
|
||||
target="_blank"
|
||||
>
|
||||
Documentation
|
||||
</Link>
|
||||
</Typography>
|
||||
|
@ -6,10 +6,6 @@ export const Literatures: Record<LiteratureName, Literature> = {
|
||||
title: "The Beginner's Guide to Hacking",
|
||||
filename: LiteratureName.HackersStartingHandbook,
|
||||
text:
|
||||
"Some resources:<br><br>" +
|
||||
"<a class='a-link-button' href='https://bitburner-official.readthedocs.io/en/latest/netscript/netscriptlearntoprogram.html' target='_blank' style='margin:4px'>Learn to Program</a><br><br>" +
|
||||
"<a class='a-link-button' href='https://bitburner-official.readthedocs.io/en/latest/netscript/netscriptjs.html' target='_blank' style='margin:4px'>For Experienced JavaScript Developers: NetscriptJS</a><br><br>" +
|
||||
"<a class='a-link-button' href='https://bitburner-official.readthedocs.io/en/latest/netscript.html' target='_blank' style='margin:4px'>Netscript Documentation</a><br><br>" +
|
||||
"When starting out, hacking is the most profitable way to earn money and progress. This " +
|
||||
"is a brief collection of tips/pointers on how to make the most out of your hacking scripts.<br><br>" +
|
||||
"-hack() and grow() both work by percentages. hack() steals a certain percentage of the " +
|
||||
|
@ -28,12 +28,6 @@ export function SleeveRoot(): React.ReactElement {
|
||||
</Container>
|
||||
|
||||
<Button onClick={() => setFAQOpen(true)}>FAQ</Button>
|
||||
<Button
|
||||
href="https://bitburner-official.readthedocs.io/en/latest/advancedgameplay/sleeves.html#duplicate-sleeves"
|
||||
target="_blank"
|
||||
>
|
||||
Wiki Documentation
|
||||
</Button>
|
||||
<Box display="grid" sx={{ gridTemplateColumns: "repeat(2, 1fr)", mt: 1 }}>
|
||||
{Player.sleeves.map((sleeve, i) => (
|
||||
<SleeveElem key={i} rerender={rerender} sleeve={sleeve} />
|
||||
|
5
src/ScriptEditor/NetscriptDefinitions.d.ts
vendored
5
src/ScriptEditor/NetscriptDefinitions.d.ts
vendored
@ -4553,10 +4553,6 @@ interface UserInterface {
|
||||
* await ns.hack('n00dles');
|
||||
* }
|
||||
* ```
|
||||
* {@link https://bitburner-official.readthedocs.io/en/latest/netscript/netscriptjs.html| ns2 in-game docs}
|
||||
* <hr>
|
||||
* For (deprecated) .script usage, see: {@link https://bitburner-official.readthedocs.io/en/latest/netscript/netscript1.html| ns1 in-game docs}
|
||||
* <hr>
|
||||
*/
|
||||
export interface NS {
|
||||
/**
|
||||
@ -6134,7 +6130,6 @@ export interface NS {
|
||||
*
|
||||
* WARNING: Port Handles only work in NetscriptJS (Netscript 2.0). They will not work in Netscript 1.0.
|
||||
*
|
||||
* @see https://bitburner-official.readthedocs.io/en/latest/netscript/netscriptmisc.html#netscript-ports
|
||||
* @param portNumber - Port number. Must be an integer between 1 and 20.
|
||||
*/
|
||||
getPortHandle(portNumber: number): NetscriptPort;
|
||||
|
@ -69,17 +69,11 @@ export function Toolbar({ editor, onSave }: IProps) {
|
||||
Terminal (Ctrl/Cmd + b)
|
||||
</Button>
|
||||
<Typography>
|
||||
{" "}
|
||||
<strong>Documentation:</strong>{" "}
|
||||
<Link target="_blank" href="https://bitburner-official.readthedocs.io/en/latest/index.html">
|
||||
Basic
|
||||
</Link>
|
||||
{" | "}
|
||||
<Link
|
||||
target="_blank"
|
||||
href="https://github.com/bitburner-official/bitburner-src/blob/dev/markdown/bitburner.ns.md"
|
||||
>
|
||||
Full
|
||||
Documentation
|
||||
</Link>
|
||||
</Typography>
|
||||
</Box>
|
||||
|
@ -13,7 +13,6 @@ import { Money } from "../../ui/React/Money";
|
||||
import { initStockMarket } from "../StockMarket";
|
||||
|
||||
import Typography from "@mui/material/Typography";
|
||||
import Link from "@mui/material/Link";
|
||||
import Button from "@mui/material/Button";
|
||||
import Tooltip from "@mui/material/Tooltip";
|
||||
import IconButton from "@mui/material/IconButton";
|
||||
@ -171,14 +170,10 @@ function Purchase4SMarketDataButton(props: IProps): React.ReactElement {
|
||||
|
||||
export function InfoAndPurchases(props: IProps): React.ReactElement {
|
||||
const [helpOpen, setHelpOpen] = useState(false);
|
||||
const documentationLink = "https://bitburner-official.readthedocs.io/en/latest/basicgameplay/stockmarket.html";
|
||||
return (
|
||||
<>
|
||||
<Typography>Welcome to the World Stock Exchange (WSE)!</Typography>
|
||||
<Link href={documentationLink} target={"_blank"}>
|
||||
<Typography>Investopedia</Typography>
|
||||
</Link>
|
||||
<br />
|
||||
<Typography variant="h4">Welcome to the World Stock Exchange (WSE)!</Typography>
|
||||
|
||||
<PurchaseWseAccountButton {...props} />
|
||||
|
||||
<Typography variant="h5" color="primary">
|
||||
|
Loading…
Reference in New Issue
Block a user