🎉 Join us to illuminate the possibilities of the future with action. →
Study 📖
Contribute To US

Contribute To US

Thank you so much for taking the time to contribute! We truly believe that with your support, Xone's future will be even brighter. ❤️

The Xone documentation is open-source and hosted in the huione-labs/docs repository on GitHub. The content edited in this repository is presented on the official Xone website at docs.xone.org. This guide outlines the contribution workflow, including opening issues, creating pull requests (PRs), reviewing, and merging PRs. Please note that contributions, pull requests, and issues should currently be written in English. In the future, we plan to launch a dedicated project to add multilingual support for technical documentation. If you're interested in helping with this initiative, feel free to reach out via the support channels mentioned in this document.

When you submit a PR for review, the Xone documentation team will merge it if approved, request changes, or comment and close the PR. We also have a dedicated team focused on documentation review, and we welcome you to join once permissions are opened if you’re interested. There are two main ways to open a pull request for documentation:

  • Fork the docs repository and work locally, or
  • For smaller updates, click the Edit this page link on the right side of any documentation page to edit directly in GitHub.

What You Should Know Before Contributing

  1. Learn how to use Nextra, as Xone's documentation is built with it.
  2. Have a GitHub account. This is essential for contributions. If you don’t have one, you can create one here >>.
  3. Familiarize yourself with how to contribute to open-source projects on GitHub, as well as the syntax for MDX and React. For advanced contributions, you can also explore NextUI and TailwindCSS to help build elegant components or styles.
  4. If you’d like to test the project locally, follow the steps in the terminal.

Setting Up the Project and Testing Locally

  1. Install pnpm.
  2. Run pnpm i to install dependencies.
  3. Run pnpm dev to start the development server.
  4. Open localhost:3000 in your browser to view the site.

Congratulations! You can now start making changes and see real-time updates whenever you save a file. 🥰

Support Channels

Submitting a Pull Request

Important Prerequisites

To prevent build issues, you should build the content locally before submitting a pull request:

  • Stop or terminate any running terminal servers, then run pnpm dev.
  • Use the terminal's output to fix any issues (e.g., broken links).
  • Run pnpm fix to automatically resolve most linting issues (e.g., formatting or style).
  • Run pnpm dev again and repeat until no issues are reported ("Client" and "Server compiled successfully").

Most pull requests should target the main branch. Occasionally, the Xone documentation team might request targeting a different branch.

Submit Your Contribution for Review:

  1. Create a new pull request on GitHub.
  2. Select a PR type from the list or choose Open a blank issue at the bottom of the page.
  3. Complete the form as required. For blank PRs, provide a clear title and accurate description/context.
  4. Click Create Pull Request to submit your PR.
  5. Add GitHub labels to your PR. Always include the documentation label, and add others based on the type of update or request.
💡
  1. If your PR isn’t ready for review, select Create Draft Pull Request. The Xone documentation team will review it only when you mark it as Ready for Review.
  2. If you don’t add update type labels, the Xone documentation team will do it for you.
  3. Approved PRs are typically merged into the main branch and trigger deployment to docs.xone.org automatically.

Once approved and merged, your contributions will appear live on docs.xone.org within minutes. 🎉

Reviewing and Managing Pull Requests

The review process and timeline depend on the Xone documentation team’s availability. The workflow includes:

  1. Assigning the PR to a documentation team member.
  2. Reviewing the PR for:
    • Accuracy
    • Quality
    • Alignment with documentation scope
  3. Approving, requesting changes, or rejecting the PR.
  4. Merging accepted PRs, which are deployed to docs.xone.org shortly after.

Other Ways to Support the Project

We appreciate all types of contributions. If you enjoy the project but don’t have time to contribute directly, here are other ways to support it:

  • Star the repository.
  • Share the project on social media.
  • Reference it in your project’s README.
  • Mention it at meetups and share it with your friends or colleagues.

The community looks forward to your contributions. 🎉

Media KitBounty Hunter