Skip to content

OffchainLabs/arbitrum-docs

Folders and files

NameName
Last commit message
Last commit date
Sep 27, 2024
Aug 2, 2024
Aug 30, 2024
Sep 26, 2024
Sep 27, 2024
Jan 30, 2023
Aug 12, 2024
Aug 12, 2024
Sep 23, 2024
Aug 23, 2024

Repository files navigation

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 reviewing our docs contribution guidelines and opening a PR!

The following are the only exceptions:

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

Dev Build

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.

Build

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

Update submodules

arbitrum-sdk repo:

git submodule update --remote arbitrum-sdk