Waveshare Docs

This repository contains the source code for the Waveshare Docs Platform.

Our goal is to continuously improve documentation quality, lower the learning curve for users, and make development simpler and more efficient.

Issue Reporting

If you encounter any issues during use, please feel free to report them through the following methods:

• Submit issues or suggestions on the Issues page of this project

Local Development

This project is built with Docusaurus. Follow these steps to preview and build locally:

# Install dependencies
npm ci

# Start local preview
npm run start

# Build static files
npm run build

# Preview static files locally
npm run serve

Contribution Guide

We welcome contributions to improve the documentation! Here is how you can help:

1. Fork the Repository - Fork this repository to your GitHub account.
2. Local Modifications - Clone the repository to your local machine and make your modifications.
3. Submit PR - Create a Pull Request, detailing the content and purpose of your changes.
4. Await Merge - We will review your PR and merge it once approved.

---

Thank you for supporting Waveshare Docs!