krofax / arbitrum-docs

Arbitrum Docs! Content + Webapp

Arbitrum Docs

Arbitrum Docs, built with docusaurus; docs are live at https://developer.arbitrum.io/.

Arbitrum SDK auto-genned docs are included as submodule.

Contribution

For most of the docs content, you can contribute by simply opening a PR!

The following are the only exceptions:

• Contributing to the three troubleshooting pages — nodes, builders, and users, as well as the glossary page — requires internal Offchain Labs access. If you'd like to make a suggestion about content on any of those pages, open an issue ticket.

• To request to have your project added to the 3rd party node providers page, use this form.

Initial set up

git clone [email protected]:OffchainLabs/arbitrum-docs.git

cd arbitrum-docs/

git submodule update --init --recursive

cd website/

Install node dependencies

yarn

You will only need to generate docs once:

yarn generate_sdk_docs

Dev Build

Live build without generating sdk docs (recommended):

yarn start_nitro_docs 

(Re)generate sdk docs and live build:

yarn start

Update submodules

Sdk repo:

git submodule update --remote arbitrum-sdk