# wiki-documents

**Repository Path**: Rockbase-iot/wiki-documents

## Basic Information

- **Project Name**: wiki-documents
- **Description**: The wiki project for RockBase IoT devices and projects.
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 0
- **Created**: 2026-10-19
- **Last Updated**: 2026-11-10

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# The RockBase IoT Wiki Files Management Platform

RockBase IoT has dedicated to making industrial IoT stable, secure and scalable. This is an open platform collecting all the wikis published by RockBase IoT, to show you the full picture of our efforts, natural environments digitization and outcome production.

This is the Github source files for RockBase IoT.

This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.

## Local development

Use Node.js 24 LTS (matching CI) and npm:

```bash
npm ci
npm start
npm run typecheck
npm run build
npm run serve
```

`npm run build` generates both English and Chinese into `build/`. The default
production URL is `https://wiki.rockbaseiot.com/`; `DOCUSAURUS_URL` and
`DOCUSAURUS_BASE_URL` can override it for another hosting path.

## Deployment

- **main** automatically deploys to **GitHub Pages**.
- **server** deploys to **EC2/VPS** as a fallback when Pages is unavailable.
- Pull requests to either branch run type checking and both language builds.

See [the deployment audit and custom-domain setup guide](WIKI_DEPLOYMENT.md)
for GitHub Pages activation, Cloudflare DNS, HTTPS, content gaps, and fallback
procedures. Existing EC2 scripts are documented in [deploy/README.md](deploy/README.md).
Switching to EC2 is an explicit deployment and DNS operation.

## What will the Wiki Platform be used for?

This platform will host all the wikis published by RockBase IoT, including but not limited to:
- Product documentation
- User guides
- API references
- Tutorials
- Release notes
- FAQs
- Troubleshooting guides


## Tech Support & Product Feedback

Thank you for choosing our products! We provide many forms of support to ensure that your experience with our products is as smooth as possible. We offer several communication channels to cater to different preferences and needs.

 - 📧 **Email** : support@rockbaseiot.com
 - 🤖 **Telegram** : [t.me/rockbase_iot](https://t.me/rockbase_iot)
 - 🌐 **Facebook** : [RockBase IoT Community](https://www.facebook.com/groups/rockbaseiot/)

## Contributing to the Wiki

We welcome contributions to our wiki! If you have suggestions for improvements, new content, or corrections, please feel free to contribute. You can submit a pull request on our GitHub repository: [RockBase IoT Wiki](https://github.com/RockBase-lab/wiki-documents)