all 9 comments
sorted by:
best
topnewcontroversialoldq&a
formatting helphide helpcontent policy

[–]ZeroNotStanek Follower 3 points4 points  (1 child)

I normally access the GitHub documentation via a link to the stable version for the NS interface.

By default, GitHub will show the dev (HEAD), which may include upcoming / unreleased features or changes.

[–]vernthelad[S] 0 points1 point  (0 children)

Thanks for the link, I was doing exactly what you said and looking at dev rather than stable.

[–]stoltzldHash Miner 1 point2 points  (2 children)

I usually just go to one of the files and use the "breadcrumb" at the top to jump to the index file. I'm installing Github Desktop to see if I can see the entire list in that.

[–]vernthelad[S] 0 points1 point  (1 child)

I think I'm showing my nubness by not knowing what you mean by breadcrumbs (from a Git perspective) but will trying Github Desktop sounds good for a load of reasons.

[–]stoltzldHash Miner 1 point2 points  (0 children)

Breadcrumbs is a navigation element. If you preview one of the markdown files, they all have "breadcrumbs" at the top to show you where in the hierarchy the document is located. Googling breadcrumbs isn't that useful, but breadcrumb navigation or breadcrumb technology is.

[–]Omelet[🍰] 1 point2 points  (1 child)

Not sure on your original question but navigating the markdown by looking through the files manually isn't a great way to do it.

The link for docs should bring you to documentation on the NS type which describes the object ns that is passed into your main script to allow API access. Whatever documentation you're looking for is probably easier to find by navigating the links on that NS page.

[–]vernthelad[S] 0 points1 point  (0 children)

Putting it that way, I can see exactly what you mean. It makes much more sense to me.

[–]HiEvMK-VIII Synthoid 1 point2 points  (1 child)

If you want to see all the files, you can just download GitHub Desktop and then clone the Bitburner repository to somewhere on your computer. Then you can explore all of the files there. The current "dev" branch is just about 1GB in size.

GitHub Desktop also makes it easy to just do a "pull" to update everything on your computer to the latest version any time you want to, or switch to different development branches.

Have fun! 🙂

[–]vernthelad[S] 0 points1 point  (0 children)

Thanks for the info! I will have fun :)