Arbitrum Docs, built with docusaurus; docs are live at https://developer.arbitrum.io/.
Arbitrum SDK auto-genned docs are included as submodule.
For most of the docs content, you can contribute by simply reviewing our docs contribution guidelines and 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.
git clone git@github.com:OffchainLabs/arbitrum-docs.git
cd arbitrum-docs/
git submodule update --init --recursive
cd website/
Install node dependencies
yarn
To start a build server to serve the docs site locally, run this command from the /website
directory:
yarn start
This command will both generate the arbitrum-sdk
docs from the submodule and start the local server. In order to update the arbitrum-sdk
docs, you will need to run this command again every time you update files in arbitrum-sdk
directory.
While in the /website
directory, this command will build the site:
yarn build
To test the build locally, you can use the following command:
yarn serve
arbitrum-sdk
repo:
git submodule update --remote arbitrum-sdk