Personal_mirrors/bitburner-src
1
0
Fork 0
mirror of https://github.com/bitburner-official/bitburner-src.git synced 2024-11-18 21:53:50 +01:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #306 from Mughur/docupdate

Browse Source 
MISC: Updated ReadTheDocs links
This commit is contained in:
Mughur 2023-01-06 15:27:18 +02:00 committed by GitHub
commit 018c344554
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
10 changed files with 27 additions and 27 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
README.md
View File

@ -14,7 +14,7 @@ See the [frequently asked questions](./doc/FAQ.md) for more information . To dis
# Documentation # Documentation
The game's official documentation can be found on [Read The The game's official documentation can be found on [Read The
Docs](http://bitburner.readthedocs.io/). Please note that this is still a work-in-progress. Docs](http://bitburner-official.readthedocs.io/). Please note that this is still a work-in-progress.
The [in-game documentation](./markdown/bitburner.md) is generated from the [TypeScript definitions](./src/ScriptEditor/NetscriptDefinitions.d.ts). The [in-game documentation](./markdown/bitburner.md) is generated from the [TypeScript definitions](./src/ScriptEditor/NetscriptDefinitions.d.ts).

4
src/GameOptions/ui/GameOptionsSidebar.tsx
View File

@ -251,7 +251,7 @@ export const GameOptionsSidebar = (props: IProps): React.ReactElement => {
</Button> </Button>
<Button <Button
startIcon={<SystemUpdateAlt />} startIcon={<SystemUpdateAlt />}
href="https://bitburner.readthedocs.io/en/latest/changelog.html" href="https://bitburner-official.readthedocs.io/en/latest/changelog.html"
target="_blank" target="_blank"
sx={{ gridArea: " changelog" }} sx={{ gridArea: " changelog" }}
> >
@ -259,7 +259,7 @@ export const GameOptionsSidebar = (props: IProps): React.ReactElement => {
</Button> </Button>
<Button <Button
startIcon={<LibraryBooks />} startIcon={<LibraryBooks />}
href="https://bitburner.readthedocs.io/en/latest/index.html" href="https://bitburner-official.readthedocs.io/en/latest/index.html"
target="_blank" target="_blank"
sx={{ gridArea: "docs" }} sx={{ gridArea: "docs" }}
> >

2
src/GameOptions/ui/RemoteAPIPage.tsx
View File

@ -20,7 +20,7 @@ export const RemoteAPIPage = (): React.ReactElement => {
text editor and then upload files to the home server. text editor and then upload files to the home server.
</Typography> </Typography>
<Typography> <Typography>
<Link href="https://bitburner.readthedocs.io/en/latest/remoteapi.html" target="_blank"> <Link href="https://bitburner-official.readthedocs.io/en/latest/remoteapi.html" target="_blank">
Documentation Documentation
</Link> </Link>
</Typography> </Typography>

6
src/Literature/Literatures.ts
View File

@ -11,9 +11,9 @@ export const Literatures: Record<string, Literature> = {};
fn = LiteratureNames.HackersStartingHandbook; fn = LiteratureNames.HackersStartingHandbook;
txt = txt =
"Some resources:<br><br>" + "Some resources:<br><br>" +
"<a class='a-link-button' href='https://bitburner.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/netscriptlearntoprogram.html' target='_blank' style='margin:4px'>Learn to Program</a><br><br>" +
"<a class='a-link-button' href='https://bitburner.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/netscriptjs.html' target='_blank' style='margin:4px'>For Experienced JavaScript Developers: NetscriptJS</a><br><br>" +
"<a class='a-link-button' href='https://bitburner.readthedocs.io/en/latest/netscript.html' target='_blank' style='margin:4px'>Netscript Documentation</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 " + "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>" + "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 " + "-hack() and grow() both work by percentages. hack() steals a certain percentage of the " +

2
src/PersonObjects/Sleeve/ui/SleeveRoot.tsx
View File

@ -36,7 +36,7 @@ export function SleeveRoot(): React.ReactElement {
<Button onClick={() => setFAQOpen(true)}>FAQ</Button> <Button onClick={() => setFAQOpen(true)}>FAQ</Button>
<Button <Button
href="https://bitburner.readthedocs.io/en/latest/advancedgameplay/sleeves.html#duplicate-sleeves" href="https://bitburner-official.readthedocs.io/en/latest/advancedgameplay/sleeves.html#duplicate-sleeves"
target="_blank" target="_blank"
> >
Wiki Documentation Wiki Documentation

6
src/ScriptEditor/NetscriptDefinitions.d.ts vendored
View File

@ -4440,7 +4440,7 @@ type UserInterface = {
* // Some related functions are gathered within a common namespace * // Some related functions are gathered within a common namespace
* stock.getPrice(); * stock.getPrice();
* ``` * ```
* {@link https://bitburner.readthedocs.io/en/latest/netscript/netscript1.html| ns1 in-game docs} * {@link https://bitburner-official.readthedocs.io/en/latest/netscript/netscript1.html| ns1 in-game docs}
* <hr> * <hr>
* <b>Basic ns2 usage example:</b> * <b>Basic ns2 usage example:</b>
* ```ts * ```ts
@ -4453,7 +4453,7 @@ type UserInterface = {
* await ns.hack('n00dles'); * await ns.hack('n00dles');
* } * }
* ``` * ```
* {@link https://bitburner.readthedocs.io/en/latest/netscript/netscriptjs.html| ns2 in-game docs} * {@link https://bitburner-official.readthedocs.io/en/latest/netscript/netscriptjs.html| ns2 in-game docs}
* <hr> * <hr>
*/ */
export type NS = { export type NS = {
@ -6304,7 +6304,7 @@ export type NS = {
* *
* WARNING: Port Handles only work in NetscriptJS (Netscript 2.0). They will not work in Netscript 1.0. * WARNING: Port Handles only work in NetscriptJS (Netscript 2.0). They will not work in Netscript 1.0.
* *
* @see https://bitburner.readthedocs.io/en/latest/netscript/netscriptmisc.html#netscript-ports * @see https://bitburner-official.readthedocs.io/en/latest/netscript/netscriptmisc.html#netscript-ports
* @param port - Port number. Must be an integer between 1 and 20. * @param port - Port number. Must be an integer between 1 and 20.
*/ */
getPortHandle(port: number): NetscriptPort; getPortHandle(port: number): NetscriptPort;

2
src/ScriptEditor/ui/ScriptEditorRoot.tsx
View File

@ -907,7 +907,7 @@ export function Root(props: IProps): React.ReactElement {
<Typography> <Typography>
{" "} {" "}
<strong>Documentation:</strong>{" "} <strong>Documentation:</strong>{" "}
<Link target="_blank" href="https://bitburner.readthedocs.io/en/latest/index.html"> <Link target="_blank" href="https://bitburner-official.readthedocs.io/en/latest/index.html">
Basic Basic
</Link> </Link>
{" | "} {" | "}

2
src/StockMarket/ui/InfoAndPurchases.tsx
View File

@ -171,7 +171,7 @@ function Purchase4SMarketDataButton(props: IProps): React.ReactElement {
export function InfoAndPurchases(props: IProps): React.ReactElement { export function InfoAndPurchases(props: IProps): React.ReactElement {
const [helpOpen, setHelpOpen] = useState(false); const [helpOpen, setHelpOpen] = useState(false);
const documentationLink = "https://bitburner.readthedocs.io/en/latest/basicgameplay/stockmarket.html"; const documentationLink = "https://bitburner-official.readthedocs.io/en/latest/basicgameplay/stockmarket.html";
return ( return (
<> <>
<Typography>Welcome to the World Stock Exchange (WSE)!</Typography> <Typography>Welcome to the World Stock Exchange (WSE)!</Typography>

26
src/Tutorial/ui/TutorialRoot.tsx
View File

@ -26,7 +26,7 @@ export function TutorialRoot(props: IProps): React.ReactElement {
<Link <Link
color="primary" color="primary"
target="_blank" target="_blank"
href="https://bitburner.readthedocs.io/en/latest/guidesandtips/gettingstartedguideforbeginnerprogrammers.html" href="https://bitburner-official.readthedocs.io/en/latest/guidesandtips/gettingstartedguideforbeginnerprogrammers.html"
> >
<Typography>Getting Started</Typography> <Typography>Getting Started</Typography>
</Link> </Link>
@ -34,7 +34,7 @@ export function TutorialRoot(props: IProps): React.ReactElement {
<Link <Link
color="primary" color="primary"
target="_blank" target="_blank"
href="https://bitburner.readthedocs.io/en/latest/basicgameplay/servers.html" href="https://bitburner-official.readthedocs.io/en/latest/basicgameplay/servers.html"
> >
<Typography>Servers & Networking</Typography> <Typography>Servers & Networking</Typography>
</Link> </Link>
@ -42,7 +42,7 @@ export function TutorialRoot(props: IProps): React.ReactElement {
<Link <Link
color="primary" color="primary"
target="_blank" target="_blank"
href="https://bitburner.readthedocs.io/en/latest/basicgameplay/hacking.html" href="https://bitburner-official.readthedocs.io/en/latest/basicgameplay/hacking.html"
> >
<Typography>Hacking</Typography> <Typography>Hacking</Typography>
</Link> </Link>
@ -50,19 +50,19 @@ export function TutorialRoot(props: IProps): React.ReactElement {
<Link <Link
color="primary" color="primary"
target="_blank" target="_blank"
href="https://bitburner.readthedocs.io/en/latest/basicgameplay/scripts.html" href="https://bitburner-official.readthedocs.io/en/latest/basicgameplay/scripts.html"
> >
<Typography>Scripts</Typography> <Typography>Scripts</Typography>
</Link> </Link>
<br /> <br />
<Link color="primary" target="_blank" href="https://bitburner.readthedocs.io/en/latest/netscript.html"> <Link color="primary" target="_blank" href="https://bitburner-official.readthedocs.io/en/latest/netscript.html">
<Typography>Netscript Programming Language</Typography> <Typography>Netscript Programming Language</Typography>
</Link> </Link>
<br /> <br />
<Link <Link
color="primary" color="primary"
target="_blank" target="_blank"
href="https://bitburner.readthedocs.io/en/latest/basicgameplay/world.html" href="https://bitburner-official.readthedocs.io/en/latest/basicgameplay/world.html"
> >
<Typography>Traveling</Typography> <Typography>Traveling</Typography>
</Link> </Link>
@ -70,7 +70,7 @@ export function TutorialRoot(props: IProps): React.ReactElement {
<Link <Link
color="primary" color="primary"
target="_blank" target="_blank"
href="https://bitburner.readthedocs.io/en/latest/basicgameplay/companies.html" href="https://bitburner-official.readthedocs.io/en/latest/basicgameplay/companies.html"
> >
<Typography>Companies</Typography> <Typography>Companies</Typography>
</Link> </Link>
@ -78,7 +78,7 @@ export function TutorialRoot(props: IProps): React.ReactElement {
<Link <Link
color="primary" color="primary"
target="_blank" target="_blank"
href="https://bitburner.readthedocs.io/en/latest/basicgameplay/infiltration.html" href="https://bitburner-official.readthedocs.io/en/latest/basicgameplay/infiltration.html"
> >
<Typography>Infiltration</Typography> <Typography>Infiltration</Typography>
</Link> </Link>
@ -86,7 +86,7 @@ export function TutorialRoot(props: IProps): React.ReactElement {
<Link <Link
color="primary" color="primary"
target="_blank" target="_blank"
href="https://bitburner.readthedocs.io/en/latest/basicgameplay/factions.html" href="https://bitburner-official.readthedocs.io/en/latest/basicgameplay/factions.html"
> >
<Typography>Factions</Typography> <Typography>Factions</Typography>
</Link> </Link>
@ -94,19 +94,19 @@ export function TutorialRoot(props: IProps): React.ReactElement {
<Link <Link
color="primary" color="primary"
target="_blank" target="_blank"
href="https://bitburner.readthedocs.io/en/latest/basicgameplay/augmentations.html" href="https://bitburner-official.readthedocs.io/en/latest/basicgameplay/augmentations.html"
> >
<Typography>Augmentations</Typography> <Typography>Augmentations</Typography>
</Link> </Link>
<br /> <br />
<Link color="primary" target="_blank" href="https://bitburner.readthedocs.io/en/latest/shortcuts.html"> <Link color="primary" target="_blank" href="https://bitburner-official.readthedocs.io/en/latest/shortcuts.html">
<Typography>Keyboard Shortcuts</Typography> <Typography>Keyboard Shortcuts</Typography>
</Link> </Link>
<br /> <br />
<Link <Link
color="primary" color="primary"
target="_blank" target="_blank"
href="https://bitburner.readthedocs.io/en/latest/netscript/netscriptlearntoprogram.html#netscript-1-0-vs-netscript-2-0" href="https://bitburner-official.readthedocs.io/en/latest/netscript/netscriptlearntoprogram.html#netscript-1-0-vs-netscript-2-0"
> >
<Typography>NS1 vs NS2 (or .script vs .js)</Typography> <Typography>NS1 vs NS2 (or .script vs .js)</Typography>
</Link> </Link>
@ -114,7 +114,7 @@ export function TutorialRoot(props: IProps): React.ReactElement {
<Link <Link
color="primary" color="primary"
target="_blank" target="_blank"
href="https://bitburner.readthedocs.io/en/latest/netscript/netscriptfunctions.html" href="https://bitburner-official.readthedocs.io/en/latest/netscript/netscriptfunctions.html"
> >
<Typography>Simplified list of functions</Typography> <Typography>Simplified list of functions</Typography>
</Link> </Link>

2
src/ui/InteractiveTutorial/InteractiveTutorialRoot.tsx
View File

@ -527,7 +527,7 @@ export function InteractiveTutorialRoot(): React.ReactElement {
<br /> <br />
<br /> <br />
The{" "} The{" "}
<a href="https://bitburner.readthedocs.io/en/latest/guidesandtips/gettingstartedguideforbeginnerprogrammers.html"> <a href="https://bitburner-official.readthedocs.io/en/latest/guidesandtips/gettingstartedguideforbeginnerprogrammers.html">
Getting Started Getting Started
</a>{" "} </a>{" "}
contains the guide for new players, navigating you through most of early game. contains the guide for new players, navigating you through most of early game.