Skip to content

Commit 958371b

Browse files
committed
Fix README.rst
Signed-off-by: Michael Heimpold <michael.heimpold@chargebyte.com>
1 parent 1480b58 commit 958371b

1 file changed

Lines changed: 20 additions & 18 deletions

File tree

README.rst

Lines changed: 20 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,21 @@
1-
Charge SOM Product Documentation
2-
================================
1+
Charge Control Y Product Documentation
2+
======================================
33

4-
This is the product documentation project for the Charge SOM, a product of chargebyte GmbH.
5-
This documentation is intended for users, developers, and administrators of the Charge SOM.
4+
This is the product documentation project for the Charge Control Y, a product of chargebyte GmbH.
5+
This documentation is intended for users, developers, and administrators of the Charge Control Y.
66
This documentation is hosted on Read the Docs and can be accessed at
77
https://chargebyte-docs.readthedocs.io/en/latest/.
88

99

10-
Contents:
11-
---------
10+
Contents
11+
--------
12+
13+
- Charge Control Y User Guide
1214

13-
- Charge SOM User Guide
1415

15-
Repo initialization:
16+
Repo Initialization
1617
-------------------
18+
1719
This repository is using git submodules to share documents between the user guides.
1820
After cloning of the project please execute the following commands:
1921

@@ -22,8 +24,8 @@ git checkout everest/charge_som
2224
git submodule update --init --force --remote
2325

2426

25-
Building the documentation locally:
26-
-----------------------------------
27+
Building the Documentation Locally
28+
----------------------------------
2729

2830
To build the documentation locally, you need to have Python and pip installed on your system.
2931
You can install the required dependencies by running the following command:
@@ -37,14 +39,14 @@ sphinx-build -a docs/source {output_directory}
3739
The output directory is the directory where the generated HTML files will be stored.
3840

3941

40-
Contributing:
41-
-------------
42+
Contributing
43+
------------
4244

4345
If you would like to contribute to the documentation, please fork the repository and create a pull
4446
request with your changes. Please make sure to follow the guidelines for contributing to the
4547
documentation:
4648

47-
- The branch name for the pull request should be `everest/csom_{your_branch_name}`.
49+
- The branch name for the pull request should be `everest/ccy_{your_branch_name}`.
4850
- Maximum line length should be 120 characters (Preferably 100 characters).
4951
- Images should be stored in the `docs/source/_static/images` directory
5052
- CSS files should be stored in the `docs/source/_static/css` directory
@@ -53,17 +55,17 @@ documentation:
5355
- A documentation file should start with referenceable label of the file name (e.g. ".. _hardware.rst:")
5456
- Sections and chapters should be separated by one blank line after the title and two blank lines before the title
5557
- Sections with a chapter title before, need to have only one blank line before the title
56-
- First letters of section and chapter titles should be capitalized (e.g. "Charge SOM User Guide")
58+
- First letters of section and chapter titles should be capitalized (e.g. "Charge Control Y User Guide")
5759

5860

59-
License:
60-
--------
61+
License
62+
-------
6163

6264
See the LICENSE file for license rights and limitations (Apache 2.0).
6365

6466

65-
Contact:
66-
--------
67+
Contact
68+
-------
6769

6870
If you have any questions or inquiries, please contact our support team at https://chargebyte.com/support.
6971

0 commit comments

Comments
 (0)