This directory contains the assets required to build and update the Sui documentation. The directory is split between content and site. To run the docs.sui.io site locally, open the site directory in a terminal or console. Use a package manager to install the required modules:
pnpm installIn the same directory, the site should be built locally:
pnpm buildThis is necessary in the first instance with a freshly cloned repo as it will download the OpenRPC specifications which are required to deploy the site.
Next, use the following command to deploy a development preview of the site to localhost:3000:
pnpm startIf you're running the site locally and getting an error saying that you don't have
open-rpcspecs, runpnpm buildfirst. It will prepare the files and fix the issue.
The deployment watches for updates to files in the content directory (and site source files), updating the UI to match any saves you make.
Once you've finished making changes, you should again run pnpm build. This builds the static site and places the files in site\build. This is important to run before submitting your changes for review, because a build will fail on errors like bad internal links, displaying the cause of the error to the console. The development preview ignores such errors to provide a more agile environment.
Sui Foundation is not able to provide support for building the documentation site locally. If you run into trouble, consult the Docusaurus documentation.
Sui uses Vercel to host its documentation site. Vercel builds a preview of the documentation for every pull request submitted to the Sui repo. You can find a link to this preview in the PR comment section from the Vercel bot. Click the Visit Preview link for the sui-core project to verify your changes behave as you expect.
If you'd like to view the Vercel preview before your changes are ready for review, then mark your PR as a draft.
Sui is for the community. Contribute for the benefit of all.
The Sui Documentation is distributed under the CC BY 4.0 license.