Skip to content

Adding fonts annotation in the PR template #1954

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion generate_config_pages.py
Original file line number Diff line number Diff line change
Expand Up @@ -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 += '<table>\n'
html_table += '\t<thead>\n' \
'\t\t<tr>\n' \
Expand Down
20 changes: 20 additions & 0 deletions pull_request_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down