Skip to main content

Contribute to Sui Documentation

The Sui documentation is open source and thrives on community contributions. Whether you’re fixing a typo, clarifying explanations, or adding entirely new content, your work benefits the whole community. You can contribute to the documentation using either GitHub’s web editor or your local development environment.

Follow the style guide​

All documentation changes must follow the Sui style guide. Reviewers provide feedback to ensure consistency in tone and quality. Don’t be discouraged if your pull request (PR) receives multiple review comments, as this process helps maintain clarity and uniformity across all docs. After your PR merges, future updates might refine your content further.

When writing, keep these key principles in mind:

  • Use active voice.
  • Write in present tense.
  • Be clear and concise. Use only as many words as needed.

GitHub web editor​

If you’re new to Git or prefer a more basic workflow, you can make small edits directly in GitHub’s web interface.

  • Add a new page

    1. Go to the docs/content directory.
    2. Open the relevant subdirectory.
    3. Click Add file → Create new file.
    4. Write your content and commit your changes.

  • Edit an existing page

    1. From the documentation website, you can use the Edit this page link at the bottom of each documentation page.
    2. From GitHub, navigate to the file you want to update. Click the pencil icon in the top-right.
    3. Make your edits and commit them.

Set up a local environment​

For larger, more significant changes to the docs, clone the documentation locally. See Sui Environment Setup for instructions on forking and cloning the Sui repository. The docs/content directory contains the documentation.

  1. Install dependencies
  2. Make your changes
    • Edit or add files in the docs/content directory.
    • Stage and commit changes: 
      git add .
      git commit -m "Describe your changes"
      git push
  3. Preview locally
    • Navigate to the docs/site directory.
    • Install dependencies (if you don’t have pnpm installed, see the pnpm installation guide): 
      pnpm install
    • Start the local dev server: 
      pnpm start
    • Open http://localhost:3000 to verify your updates.

Review process​

When your changes are ready:

  1. Submit a PR to the main branch of the Sui repository.
  2. Vercel generates a preview so you can verify your changes. The preview is what you can expect to see online after your changes merge.
  3. Reviewers provide feedback. It’s your responsibility to update your PR based on their comments. Multiple reviewers might give input.
  4. After at least one reviewer approves your PR, it merges into main, and your contribution goes live. Changes appear on the live website within 5-10 minutes after the PR has merged into main.