DOC: Death to readthedocs #667

hydroflame · 2023-07-10T02:15:40Z

Implement markdown with MUI.
Move and convert all rst documentation to md
Rework documentation a little bit.
Rename Tutorial tab to Documentation tab

TheMas3212

looks good to me

src/Tutorial/ui/root.ts

d0sboots

Code generally looks good. I didn't try running it, though.

d0sboots · 2023-07-10T07:27:51Z

src/Tutorial/ui/DocumentationRoot.tsx

+import { getPage } from "./root";
+import { Navigator, useHistory } from "../../ui/React/Documentation";
+
+const resolveRelativePath = (folder: string, relative: string): string => {


Pretty sure we already have utility functions for these.

We do but there is a little finessing needed to get the existing resolveFilePath to work here, since it defaults to using an absolute path unless the path actually starts with ./ or ../

I posted a suggestion but this can easily be dealt with later once everything is working correctly, even in a followup PR.

d0sboots · 2023-07-10T07:31:28Z

src/Tutorial/ui/doc/advanced/bladeburners.md

@@ -0,0 +1,3 @@
+# Bladeburners
+
+PLACEHOLDER


There's a lot of files like this still. This is a lot of docs to bite off in one chunk. IMO it would make more sense to delete each RST as it is converted, and do them in batches, but if you want to do them all in one go I'm not gonna stop you.

src/Tutorial/ui/doc/notfound.md

src/ui/MD/MD.tsx

src/ui/MD/md_test.ts

src/ui/MD/a.tsx

Just committing a minimal fix so there's a working base for anyone doing testing Build: fixed filename on an import Lint: Removed empty function on useEffect, then removed unused useEffect import Format: Removed a double-newline in autogen file

Snarling · 2023-07-11T11:58:30Z

@hydroflame I see what you mean with renaming the directory not working right, it works fine locally but the rename doesn't actually get reflected in the commit, so the committed version still fails to build.

I'm renaming that folder to Markdown, that way the change is not strictly capitalization and it should go through. Sorry for any inconvenience, not trying to step on your toes just trying to get this in a state where people can continue to test it without needing to apply local fixes to make the game build.

Snarling

Button links don't get the right font right now:

Locally I was able to fix this by getting rid of all the useStyles/makeStyles stuff in a.tsx and adding to props: variant="body1" fontSize="inherit":

…c into markdown

hydroflame · 2023-07-11T22:58:13Z

I think addressed everything.

@Snarling No need to feel bad for fixing my stuff. I appreciate it. I didn't know it prevented other people from building though.

Now I'm going to fill in all the placeholders.

hydroflame · 2023-07-12T01:45:45Z

I had to rename the folder Markdown to MD again because prettier would ignore the files under it.

hydroflame · 2023-07-12T01:49:28Z

There are still some placeholder files but it's too mind numbing to write these things. I hope a user will get annoyed enough to write it for us.

hydroflame · 2023-07-12T02:03:21Z

Fix #624

d0sboots · 2023-07-12T23:05:10Z

There are still some placeholder files but it's too mind numbing to write these things. I hope a user will get annoyed enough to write it for us.

Noooooo why not md ;_;

Edit: Replied to the wrong comment, but this comment is important too. This is exactly what I was worried about when you started by deleting all the .rst. Writing documentation is mind-numbing; you can't count on anyone else doing it. I don't think we should be deleting the unconverted docs until they have converted replacements.

Your Name added 12 commits July 6, 2023 18:02

first pass at md in bitburner

8b559bd

Convert some RST

1c3c213

some doc

f821855

Clean up rst in the new md files

c5edee5

finish first round of cleanup

d122642

Clean coding contracts.md

ed5fca4

Clean coding contracts.md

cd8e2d7

Added spoilers feature

b791d39

Rename the tutorial tab to documentation

806dc4c

lint

3676f31

testing relative links

d1fd4c0

Add documentation in-game

176a27c

github-actions bot added the error: invalid title PR title must follow specific format label Jul 10, 2023

hydroflame changed the title ~~Remove readthedoc completely and move everything in-game.~~ DOCUMENTATION: Remove readthedoc completely and move everything in-game. Jul 10, 2023

github-actions bot removed the error: invalid title PR title must follow specific format label Jul 10, 2023

Your Name added 2 commits July 9, 2023 22:23

fmt

db60eb1

Move tutorial reset to options

2b8c341

hydroflame changed the title ~~DOCUMENTATION: Remove readthedoc completely and move everything in-game.~~ DOC: Death to readthedocs Jul 10, 2023

Your Name added 2 commits July 9, 2023 22:52

Fix test suite hopefully

873538b

test round 2

5be4d0b

bitburner-official deleted a comment from github-actions bot Jul 10, 2023

TheMas3212 approved these changes Jul 10, 2023

View reviewed changes

src/Tutorial/ui/root.ts Outdated Show resolved Hide resolved

d0sboots reviewed Jul 10, 2023

View reviewed changes

Snarling reviewed Jul 10, 2023

View reviewed changes

src/ui/MD/a.tsx Outdated Show resolved Hide resolved

This comment was marked as resolved.

Sign in to view

Address comments

7c48c14

This comment was marked as resolved.

Sign in to view

build/lint/format fixes

5c00c32

Just committing a minimal fix so there's a working base for anyone doing testing Build: fixed filename on an import Lint: Removed empty function on useEffect, then removed unused useEffect import Format: Removed a double-newline in autogen file

Rename directory MD->Markdown

82ab46f

Snarling reviewed Jul 11, 2023

View reviewed changes

Your Name added 4 commits July 11, 2023 18:40

more work

1c5a830

Merge branch 'markdown' of github.com:bitburner-official/bitburner-sr…

280fd34

…c into markdown

lint

191b590

fix font for links

b67e817

Wrote some documentation but I'm dying of boredom.

4cb9747

lint/fmt

108543d

Snarling merged commit 1a8b9a9 into dev Jul 12, 2023
5 checks passed

Snarling deleted the markdown branch July 12, 2023 21:10

Hoekstraa mentioned this pull request Aug 3, 2023

Integrate documentation into the game #624

Closed

catloversg mentioned this pull request Aug 11, 2024

DOCUMENTATION: Convert old rst files to md files #1564

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

DOC: Death to readthedocs #667

DOC: Death to readthedocs #667

hydroflame commented Jul 10, 2023 •

edited

Loading

TheMas3212 left a comment

d0sboots left a comment

d0sboots Jul 10, 2023

Snarling Jul 11, 2023 •

edited

Loading

d0sboots Jul 10, 2023

This comment was marked as resolved.

This comment was marked as resolved.

Snarling commented Jul 11, 2023

Snarling left a comment

hydroflame commented Jul 11, 2023

hydroflame commented Jul 12, 2023

hydroflame commented Jul 12, 2023

hydroflame commented Jul 12, 2023

d0sboots commented Jul 12, 2023 •

edited

Loading

DOC: Death to readthedocs #667

DOC: Death to readthedocs #667

Conversation

hydroflame commented Jul 10, 2023 • edited Loading

TheMas3212 left a comment

Choose a reason for hiding this comment

d0sboots left a comment

Choose a reason for hiding this comment

d0sboots Jul 10, 2023

Choose a reason for hiding this comment

Snarling Jul 11, 2023 • edited Loading

Choose a reason for hiding this comment

d0sboots Jul 10, 2023

Choose a reason for hiding this comment

This comment was marked as resolved.

This comment was marked as resolved.

Snarling commented Jul 11, 2023

Snarling left a comment

Choose a reason for hiding this comment

hydroflame commented Jul 11, 2023

hydroflame commented Jul 12, 2023

hydroflame commented Jul 12, 2023

hydroflame commented Jul 12, 2023

d0sboots commented Jul 12, 2023 • edited Loading

hydroflame commented Jul 10, 2023 •

edited

Loading

Snarling Jul 11, 2023 •

edited

Loading

d0sboots commented Jul 12, 2023 •

edited

Loading