Practical overview
When it fits
Use the hosted wiki for Gear development guidance; use the repository workflow when you want to preview or contribute documentation changes.
Who it is for
- Developers learning or building with the Gear ecosystem.
- Contributors who want to edit or propose changes to Gear documentation.
Documented uses
- Find guides for getting started with Gear development.
- Preview documentation edits in a locally running wiki.
- Propose documentation changes through an issue or pull request.
Requirements & limits
- The project repository is JavaScript-based, and its local setup calls for Node.js with Yarn or npm.
- The setup instructions include a locale option and give
zh-cnas an example. - Wiki content is distributed under the CC0 1.0 Universal License.
Check current requirements in the official documentation. Source-based guidance does not mean OpenViST has run or independently tested this project.
Run a local Gear Wiki for documentation edits
Start a local copy of the wiki and view it in a browser while tracking changes.
Before you start
- Node.js
- Yarn or npm
Steps
Clone https://github.com/gear-foundation/gear-wiki and enter the repository directory.
Install dependencies with
yarn installor the command below.npm installStart the site with
yarn startor the command below.npm run startOpen
http://localhost:3000/in a browser.
Expected outcome
A local wiki copy runs in a browser, where contributors can follow their edits.
Guide limitations
- The instructions describe local startup and preview, not deployment.
Start the local wiki with a specified locale
Run the local wiki using a locale option, following the documented Chinese example.
Before you start
- Node.js
- Yarn
- A cloned Gear Wiki repository with dependencies installed
Steps
From the repository, run
yarn start --locale.For the documented Chinese example, use
yarn start --locale zh-cn.
Expected outcome
The local wiki starts with the selected locale option.
Guide limitations
- The instructions show a Chinese locale example but do not enumerate other supported locale values.
Sources & review
Source record details
- Source availability
- Active
- Sources checked
- 14 October 2026
- Original website title
- gear-foundation/gear-wiki · Official homepage title · retained in its source language

