Skip to main content

PR Format instructions for project share (Template)

· 2 min read
tip

The above is the Frontmatter content. This part of the content will not be displayed in the main body of the document, but it is very important index information. The content corresponding to the field should be relevant to your project.

Your project title​

tip

A horizontal image that shows your final work or the effect you achieved, with a recommended ratio of 16:9 (Not mandatory), such as 1000 x 562 resolution. svg, png, jpg, jpeg are fine.

This image serves two purposes:

  1. As a feature image on the homepage;
  2. As a showcase for your final work or the effect you achieved.

A brief summary of what your project is doing, what it achieves, what problems it solves, etc.

Contest Content Template Usage Guide

· One min read

Step 1​

Frok Heltec Wi-Ki repository, and clone the forked project into local. Copy the contest-content-template file in the news folder, rename it into your project name, lowercase, spaces are replaced by -.

Enter the folder and change the name of "contest-content-template.md" to the same as the parent directory.

Now your folder structure should look like this

Heltec_Docs_News/
├── docs/                           # 文档目录
│   ├── devices/             # Wiki 文档 1
│   ├── platform/             # Wiki 文档 2
│   ├── intro.md
│   └── platforms.md
│
├── news/                           # 文档目录
│   ├── my-project-name/             # Wiki 文档 1
│   │   ├── img/
│   │   │   ├── 01.svg
│   │   │   ├── 02.png
│   │   │   ├── 03.png
│   │   │   ├── 04.png
│   │   │   └── ...
│   │   └── my-project-name.md         # 子目录中的 Wiki
│   ├── contest-content-template/             # Wiki 文档 1
│   ├── contest-content-template-usage-guide/             # Wiki 文档 2
│   ├── 2025-Heltec-Maker-Contest.md
│   ├── 2025-Heltec-Maker-Contest-Privacy-Policy.md
│   ├── authors.yml
│   └── tags.yml
│
├── scripts/
│   └── ...
│
├── src/
│   └── ...
└── ...

Step 2​

Now you can start creating your project in the my-project-name.md file. Put the relevent pictures into the img directory under my-project-name. Submit a PR to Heltec Wi-Ki repository, then wait for review. After the review is passed, your post will be displayed on Heltec News Page.

2025 Heltec Maker Contest Privacy Policy

· 7 min read

Data Controller: Heltec Automation Co., Ltd.

Contact: If you have any questions or concerns, please feel free to reach out to us at support@heltec.cn Protecting your privacy is important to Heltec. This Privacy Statement explains how Heltec processes personal data collected through websites, products, and services (“applications”), including those distributed by our resellers and other channel partners, and through in-person and digital events, webinars, surveys, marketing activities, and visits to our premises (along with applications, collectively our “offerings”). This Privacy Statement describes how we process personal data for our own purposes. We also process personal data on behalf of our customers subject to a written contract.