Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

MISC: Improve tutorial, documentation and discoverability of NS API documentation #1697

Conversation

catloversg
Copy link
Contributor

Tutorial

  • Change the example of the hack script:
    • Add /** @param {NS} ns */.
    • Change the tab character to double space characters.
  • Mention "NS API documentation".

Capture1

Documentation

Update README.md.

Discoverability of NS API documentation:

Script Editor tab:
Before:
before
After:
after

Documentation tab:
Before:
before
After:
after

Note: There is a "side-effect" of this change: all external links will be changed in the same way as the NS API documentation link. For example:
Capture

Closes #1696.

Copy link
Collaborator

@d0sboots d0sboots left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think the "side-effect" of external links being styled a little differently is a good one. It shouldn't be a style difference for just the NS API, it is better for it to be a systematic reason.

src/ui/InteractiveTutorial/InteractiveTutorialRoot.tsx Outdated Show resolved Hide resolved
@d0sboots d0sboots merged commit 6d8084f into bitburner-official:dev Oct 21, 2024
5 checks passed
@catloversg catloversg deleted the pull-request/misc/improve-tutorial-documentation-and-discoverability-of-ns-api-documentation branch October 21, 2024 04:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Official code documentation is hard to find
3 participants