From 92b1062a25359c40e74ec2a53a8c17328fbd6a88 Mon Sep 17 00:00:00 2001 From: d2eight Date: Mon, 7 Apr 2025 19:47:41 +0300 Subject: [PATCH] adding fonts annotation in the PR template, changed config pages python file, with correct headings --- generate_config_pages.py | 2 +- pull_request_template.md | 20 ++++++++++++++++++++ 2 files changed, 21 insertions(+), 1 deletion(-) diff --git a/generate_config_pages.py b/generate_config_pages.py index 6ba25a3378..956923e2c6 100644 --- a/generate_config_pages.py +++ b/generate_config_pages.py @@ -76,7 +76,7 @@ def extract_property_info(properties): def generate_html_table(table_name, rows): - html_table = '#### ' + table_name + '\n\n' + html_table = '## ' + table_name + '\n\n' html_table += '\n' html_table += '\t\n' \ '\t\t\n' \ diff --git a/pull_request_template.md b/pull_request_template.md index 1ec37a3f58..934e57a9fe 100644 --- a/pull_request_template.md +++ b/pull_request_template.md @@ -2,6 +2,26 @@ The documentation updated for ... +## Fonts annotation + +1. When adding new pages to the documentation, it is necessary to follow the hierarchy of headings, starting with h2 +2. The main section heading is set via h2. +3. All nested headings should follow the structure and use: + h3 - for subsections inside h2 + h4 - for subsections inside h3 and so on + +Here is an example (https://thingsboard.io/docs/pe/user-guide/rbac/) of correct headings structure: +'## Roles' +'### Creating a new role' +'### Generic roles' +'#### Example' +'#### Permissions' +'### Group roles' +'#### Example' +'## Solution example for smart buildings: separate user groups per facility' + +Check font-size of yours button it should be 16px, here is an example https://thingsboard.io/docs/pe/getting-started-guides/what-is-thingsboard/ + ## Link checker The links will be checked by the build agent automatically once you create or update your PR.