Skip to content

Commit d629c32

Browse files
committed
Update Image spelling
1 parent 5441bd6 commit d629c32

9 files changed

+33
-30
lines changed

docs/guides/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@
2424
- [Silicon Labs - Software Update](./silabs_efr32_software_update.md)
2525
- [Silicon Labs - CLI Guide](./silabs_cli_guide.md)
2626
- [STMicroelectronics (STM32)](./stm32_getting_started_guide.md)
27-
- [TI - Platform Overview](./ti/ti_platform_overview.md)
27+
- [TI - Platform Overview](./ti/matter-users-guide/ti_matter_overview.md)
2828
- [Open IoT SDK - Platform Overview](./openiotsdk_platform_overview.md)
2929
- [Open IoT SDK - Examples](./openiotsdk_examples.md)
3030
- [Open IoT SDK - Unit Tests](./openiotsdk_unit_tests.md)

docs/guides/darwin.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -267,7 +267,7 @@ Example:
267267
- [Silicon Labs](./silabs_getting_started.md)
268268
- [Simulated Linux](./simulated_device_linux.md)
269269
- [Telink](/examples/lighting-app/telink/README.md)
270-
- [TI Platform](./ti/ti_platform_overview.md)
270+
- [TI Platform](./ti/matter-users-guide/ti_matter_overview.md)
271271
- [TI All Clusters](/examples/all-clusters-app/cc13x4_26x4/README.md)
272272
- [Tizen](/examples/lighting-app/tizen/README.md)
273273

docs/guides/index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ ti/ti_platform_overview
4040
- [Silicon Labs - Getting Started](./silabs_getting_started.md)
4141
- [Silicon Labs - Software Update](./silabs_efr32_software_update.md)
4242
- [Silicon Labs - CLI Guide](./silabs_cli_guide.md)
43-
- [TI - Platform Overview](./ti/ti_platform_overview.md)
43+
- [TI - Platform Overview](./ti/matter-users-guide/ti_matter_overview.md)
4444

4545
## Tool Guides
4646

Original file line numberDiff line numberDiff line change
@@ -1,26 +1,29 @@
11
# Get started with SysConfig
22

3-
System Configuration Tool (SysConfig) is a graphical interface for
4-
configuring your project. Configuration files, C source files and header
5-
files are generated based on the parameters configured in the SysConfig
6-
dashboard.
3+
System Configuration Tool (SysConfig) is a graphical interface for configuring
4+
your project. Configuration files, C source files and header files are generated
5+
based on the parameters configured in the SysConfig dashboard.
76

8-
SysConfig should be used as a standalone tool for script-based builds (such as for Matter).
7+
SysConfig should be used as a standalone tool for script-based builds (such as
8+
for Matter).
99

10-
The document will help for getting started in tailoring the syscfg file to your application needs.
10+
The document will help for getting started in tailoring the `syscfg` file to
11+
your application needs.
1112

1213
## Using Stand-alone SysConfig
1314

14-
You can find the standalone SysConfig tool on the [SysConfig Standalone
15-
Installer Download Page](https://www.ti.com/tool/SYSCONFIG).
15+
You can find the standalone SysConfig tool on the
16+
[SysConfig Standalone Installer Download Page](https://www.ti.com/tool/SYSCONFIG).
1617

17-
The location of the Matter syscfg file is located here: `/examples/<name>/cc13x4_26x4/chip.syscfg`
18-
For example, on the github web: https://github.com/project-chip/connectedhomeip/blob/master/examples/lock-app/cc13x4_26x4/chip.syscfg
18+
The location of the Matter `syscfg` file is located here:
19+
`/examples/<name>/cc13x4_26x4/chip.syscfg` For example, on the github web:
20+
`https://github.com/project-chip/connectedhomeip/blob/master/examples/lock-app/cc13x4_26x4/chip.syscfg`
1921
The local file in your cloned repository should be used.
2022

21-
This file is used by Matter build scripts, when it invokes SysConfig CLI.
22-
In order to edit the file for your custom application configurations, you'll need to open the file with the SysConfig GUI.
23-
Before doing so, you should add the following line above the `/* Modules */` comment:
23+
This file is used by Matter build scripts, when it invokes SysConfig CLI. In
24+
order to edit the file for your custom application configurations, you'll need
25+
to open the file with the SysConfig GUI. Before doing so, you should add the
26+
following line above the `/* Modules */` comment:
2427

2528
```
2629
// @cliArgs --product <path to SDK>/.metadata/product.json --board /ti/boards/LP_EM_CC1354P10_6 --rtos freertos
@@ -38,22 +41,22 @@ If the file is not found, then you may need to first initialize the submodules:
3841
git submodule update --init
3942
```
4043

41-
Now you can open the file in SysConfig GUI.
42-
Once you are done, remove the `@cliArgs` line then save the file. Now the Matter build scripts will use the updated .syscfg file.
44+
Now you can open the file in SysConfig GUI. Once you are done, remove the
45+
`@cliArgs` line then save the file. Now the Matter build scripts will use the
46+
updated `.syscfg` file.
4347

4448
## Viewing SysConfig Output
4549

46-
To preview the code to be generated reference the `Generated Files` image, the button at the top of
47-
the `Configuration` pane you will find a list of Generated Files. After
48-
selecting a file you will be able, in real-time, to identify how the
49-
changes in the GUI affect the generated files. This will help you review
50-
the relationship between the GUI and the code.
50+
To preview the code to be generated reference the `Generated Files` image, the
51+
button at the top of the `Configuration` pane you will find a list of Generated
52+
Files. After selecting a file you will be able, in real-time, to identify how
53+
the changes in the GUI affect the generated files. This will help you review the
54+
relationship between the GUI and the code.
5155

5256
<div style="text-align: center;">
53-
<img src="images/syscfg_generated_files_ble.png" alt="Generated Files" width=30%>
57+
<img src="images/generated_files_ble.png" alt="Generated Files" width=30%>
5458
<div class="caption">Generated Files</div>
5559
</div>
5660

57-
Whenever you re-build the project, SysConfig will re-generate the files.
58-
Because of this, any changes made directly in the generated files will
59-
be overwritten.
61+
Whenever you re-build the project, SysConfig will re-generate the files. Because
62+
of this, any changes made directly in the generated files will be overwritten.

docs/guides/ti/matter-syscfg/sysconfig-board.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ Below are the steps required to utilize the Reserve Peripherals feature.
4444
2. Open the panel \"Reserve Peripherals\"
4545

4646
<div style="text-align: center;">
47-
<img src="images/syscfg-reserve-peripheral-panel.png" width=30%>
47+
<img src="images/reserve-peripheral-panel.png" width=30%>
4848
</div>
4949

5050
3. Reserve the resources
@@ -53,7 +53,7 @@ Below are the steps required to utilize the Reserve Peripherals feature.
5353
15
5454

5555
<div style="text-align: center;">
56-
<img src="images/syscfg-reserve-gpio.png" width=30%>
56+
<img src="images/reserve-gpio.png" width=30%>
5757
</div>
5858

5959
SysConfig ensures no resource conflict occurs. In case no solution can be found,
@@ -70,5 +70,5 @@ resources.
7070
Sysconfig Hardware View:
7171

7272
<div style="text-align: center;">
73-
<img src="images/syscfg_hardware_view.png" width=30%>
73+
<img src="images/hardware_view.png" width=30%>
7474
</div>

0 commit comments

Comments
 (0)