Skip to content

Commit

Permalink
doc: update CHIP name in docs/ files
Browse files Browse the repository at this point in the history 
Changed CHIP to Matter in md files in docs/.

Signed-off-by: Grzegorz Ferenc <[email protected]>
  • Loading branch information
@greg-fer
greg-fer committed Oct 15, 2021
1 parent bb8785c commit e1dd074
Show file tree
Hide file tree
Showing 4 changed files with 27 additions and 27 deletions.
10 changes: 5 additions & 5 deletions docs/PROJECT_FLOW.md
View file
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
## CHIP Project Flow
## Matter Project Flow

This section is intended to cover how CHIP uses GitHub Projects, Issues,
This section is intended to cover how Matter uses GitHub Projects, Issues,
Milestones, Releases, and Branches for program/project management in the code
repository.

### Issues

CHIP uses issues as simple problem descriptions or feature requests. In general,
Matter uses issues as simple problem descriptions or feature requests. In general,
all work contributed to the repository in the form of pull requests (PR) should
be under the auspices of some open issue. This may seem onerous and in some
cases duplicative, so consider these guidelines when deciding whether to you can
Expand Down Expand Up @@ -38,7 +38,7 @@ PR Don'ts:

### Milestones

In CHIP parlance, a milestone is simply a tag for an expected due date or
In Matter parlance, a milestone is simply a tag for an expected due date or
release. Milestones are intended to help contributors and their managers to
prioritize work. There are 2 types: Date-based and Release-based.

Expand Down Expand Up @@ -80,6 +80,6 @@ one of the task-tracking projects (the first type).

### Branches, releases, and general development flow

Master should always be CHIPs best branch. Release branches, once cut, are
Master should always be Matter's best branch. Release branches, once cut, are
closed for any feature work. Software fixes for release branches must first land
on master unless demonstrably infeasible.
12 changes: 6 additions & 6 deletions docs/QUICK_START.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,15 @@

## Demo Overview

The CHIP reference implementation contains support for a number examples and
The Matter reference implementation contains support for a number examples and
platforms.

## WiFi Nodes
## Wi-Fi Nodes

| <div style="width:200px">Controller / Admin</div> | <div style="width:200px">Node</div> | Description |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [**chip-tool**](https://github.com/project-chip/connectedhomeip/blob/master/examples/chip-tool/README.md) (Linux / Mac)<br> Includes docs for all the cluster commands supported <br> | **all-clusters-app** <li> [M5Stack](https://github.com/project-chip/connectedhomeip/blob/master/examples/all-clusters-app/esp32/README.md) (ESP)<li>[Linux](https://github.com/project-chip/connectedhomeip/tree/master/examples/all-clusters-app/linux) simulation | Use the command line tool on a laptop to pair with and control an embedded WiFi platform. This demo supports the “all-clusters-app”, so it provides the basic onoff light test and more. Two incremental modes of operation are supported for testing (configurable via Kconfig tool when building M5): <ol><li> Unsecured (WiFi only) <br> BLE Rendezvous Mode Bypass = 1 <li> PASE secured <br> (BLE pairing, WiFi operational) </ol> |
| [**chip-device-ctrl.py**](https://github.com/project-chip/connectedhomeip/blob/master/src/controller/python/README.md) | **all-clusters-app**<li> [M5Stack](https://github.com/project-chip/connectedhomeip/blob/master/examples/all-clusters-app/esp32/README.md) (ESP)<li> [Linux](https://github.com/project-chip/connectedhomeip/tree/master/examples/all-clusters-app/linux) simulation | Same as above, but uses the pychip tool as Controller Node, and focuses on BLE flow rather than Bypass. |
| [**chip-tool**](https://github.com/project-chip/connectedhomeip/blob/master/examples/chip-tool/README.md) (Linux / Mac)<br> Includes docs for all the cluster commands supported <br> | **all-clusters-app** <li> [M5Stack](https://github.com/project-chip/connectedhomeip/blob/master/examples/all-clusters-app/esp32/README.md) (ESP)<li>[Linux](https://github.com/project-chip/connectedhomeip/tree/master/examples/all-clusters-app/linux) simulation | Use the command line tool on a laptop to pair with and control an embedded Wi-Fi platform. This demo supports the “all-clusters-app”, so it provides the basic onoff light test and more. Two incremental modes of operation are supported for testing (configurable via Kconfig tool when building M5): <ol><li> Unsecured (Wi-Fi only) <br> Bluetooth LE Rendezvous Mode Bypass = 1 <li> PASE secured <br> (BLE pairing, Wi-Fi operational) </ol> |
| [**chip-device-ctrl.py**](https://github.com/project-chip/connectedhomeip/blob/master/src/controller/python/README.md) | **all-clusters-app**<li> [M5Stack](https://github.com/project-chip/connectedhomeip/blob/master/examples/all-clusters-app/esp32/README.md) (ESP)<li> [Linux](https://github.com/project-chip/connectedhomeip/tree/master/examples/all-clusters-app/linux) simulation | Same as above, but uses the pychip tool as Controller Node, and focuses on Bluetooth LE flow rather than Bypass. |

## Thread Nodes

Expand All @@ -20,7 +20,7 @@ combination listed below.
| <div style="width:200px">Border Router</div> | <div style="width:200px">Node</div> | Description |
| -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [**ot-br**](https://openthread.io/guides/border-router/build)<br>Thread Border Router <li>RasPi <li>BeagleBone | **lighting-app** <li>[Nordic nRF5x](https://github.com/project-chip/connectedhomeip/tree/master/examples/lighting-app/nrfconnect/README.md) <li> [NXP K32W](https://github.com/project-chip/connectedhomeip/tree/master/examples/lighting-app/k32w/README.md) <li> [Qorvo QPG6100](https://github.com/project-chip/connectedhomeip/tree/master/examples/lighting-app/qpg) <li> [Silicon Labs EFR32](https://github.com/project-chip/connectedhomeip/tree/master/examples/lighting-app/efr32/README.md) | The Lighting example is supported by many of the available Thread platforms. See the chip-tool controller instructions for how to actuate the light on/off cluster. |
| [**ot-br**](https://openthread.io/guides/border-router/build)<br>Thread Border Router <li>RasPi <li>BeagleBone | **lock-app** <li>[Nordic nRF5x](https://github.com/project-chip/connectedhomeip/tree/master/examples/lock-app/nrfconnect/README.md) <li> [NXP K32W](https://github.com/project-chip/connectedhomeip/tree/master/examples/lock-app/k32w/README.md) <li> [Qorvo QPG6100](https://github.com/project-chip/connectedhomeip/tree/master/examples/lock-app/qpg) <li> [Silicon Labs EFR32](https://github.com/project-chip/connectedhomeip/tree/master/examples/lock-app/efr32/README.md) <li> [TI CC13x2x7](https://github.com/project-chip/connectedhomeip/tree/master/examples/lock-app/cc13x2x7_26x2x7/README.md) | The Lock example is supported by many of the available Thread and WiFi platforms. |
| [**ot-br**](https://openthread.io/guides/border-router/build)<br>Thread Border Router <li>RasPi <li>BeagleBone | **lock-app** <li>[Nordic nRF5x](https://github.com/project-chip/connectedhomeip/tree/master/examples/lock-app/nrfconnect/README.md) <li> [NXP K32W](https://github.com/project-chip/connectedhomeip/tree/master/examples/lock-app/k32w/README.md) <li> [Qorvo QPG6100](https://github.com/project-chip/connectedhomeip/tree/master/examples/lock-app/qpg) <li> [Silicon Labs EFR32](https://github.com/project-chip/connectedhomeip/tree/master/examples/lock-app/efr32/README.md) <li> [TI CC13x2x7](https://github.com/project-chip/connectedhomeip/tree/master/examples/lock-app/cc13x2x7_26x2x7/README.md) | The Lock example is supported by many of the available Thread and Wi-Fi platforms. |

## Controllers

Expand All @@ -39,7 +39,7 @@ to use `chip-tool pairing onnetwork 34567890`, because the unit tests change the
device configuration.

NOTE: to run both the Node and Controller as separate processes on the same
Linux or Mac machine, build the all-clusters-app with BLE disabled as follows:
Linux or Mac machine, build the all-clusters-app with Bluetooth LE disabled as follows:

`scripts/examples/gn_build_example.sh examples/all-clusters-app/linux out/debug/standalone/ chip_config_network_layer_ble=false`

Expand Down
24 changes: 12 additions & 12 deletions docs/STYLE_GUIDE.md
View file
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
# CHIP Documentation Style Guide
# Matter Documentation Style Guide

CHIP documentation lives here:
Matter documentation lives here:

- **GitHub** — All guides and tutorials across the complete
[Project-CHIP organization](https://github.com/project-chip).
[Matter organization](https://github.com/project-chip).

See
[CONTRIBUTING.md](https://github.com/project-chip/connectedhomeip/blob/master/CONTRIBUTING.md)
Expand All @@ -22,13 +22,13 @@ Current documentation structure:
| `/actions` | Custom GitHub actions |
| `/docs/guides` | Conceptual or usage content that doesn't fit within a subdirectory, and high-level tutorials |
| `/docs/guides/images` | All images included in guide content |
| `/docs/guides/profiles` | Content describing or illustrating use of CHIP profiles |
| `/docs/guides/test` | Content related to testing CHIP |
| `/docs/guides/tools` | Content describing or illustrating use of CHIP tools |
| `/docs/guides/primer` | CHIP Primer content |
| `/docs/presentations` | PDF presentations on CHIP features |
| `/docs/specs` | PDFs of CHIP specifications |
| `/images` | Top-level CHIP images, such as logos |
| `/docs/guides/profiles` | Content describing or illustrating use of Matter profiles |
| `/docs/guides/test` | Content related to testing Matter |
| `/docs/guides/tools` | Content describing or illustrating use of Matter tools |
| `/docs/guides/primer` | Matter Primer content |
| `/docs/presentations` | PDF presentations on Matter features |
| `/docs/specs` | PDFs of Matter specifications |
| `/images` | Top-level Matter images, such as logos |

If you are unsure of the best location for your contribution, create an Issue
and ask, or let us know in your Pull Request.
Expand All @@ -43,11 +43,11 @@ For consistency, all document links should point to the content on GitHub.

The text of a link should be descriptive, so it's clear what the link is for:

> For more information, see the [CHIP Style Guide](./STYLE_GUIDE.md).
> For more information, see the [Matter Style Guide](./STYLE_GUIDE.md).
## Markdown guidelines

Use standard Markdown when authoring CHIP documentation. While HTML may be used
Use standard Markdown when authoring Matter documentation. While HTML may be used
for more complex content such as tables, use Markdown as much as possible.

> Note: Edit this file to see the Markdown behind the examples.
Expand Down
8 changes: 4 additions & 4 deletions docs/VSCODE_DEVELOPMENT.md
View file
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
# Visual Studio Code Development

[Visual Studio Code](https://code.visualstudio.com/) is a great and simple IDE
that can be used to build & develop with for CHIP.
that can be used to build & develop with for Matter.

CHIP supports the docker / remote container workflow in Visual Studio Code, and
Matter supports the docker / remote container workflow in Visual Studio Code, and
has a container environment setup automatically. You can read more about this
workflow [here](https://code.visualstudio.com/docs/remote/containers).

Expand All @@ -26,7 +26,7 @@ Tested on:
1. Install [Git](https://git-scm.com/) if you haven't already
1. _Windows Only_ Enable git to use LF instead of CLRF by default:
`git config --global core.autocrlf false`
1. Git clone the main CHIP repository here:
1. Git clone the main Matter repository here:
<https://github.com/project-chip/connectedhomeip>
1. Launch Visual Studio Code, and open the cloned folder from
1. Install the
Expand All @@ -42,7 +42,7 @@ Tested on:
to use Bash on Ubuntu (on Windows) eg:
`"terminal.integrated.shell.windows": "C:\\Windows\\System32\\bash.exe"`
1. Now your local machine is building a docker image that has all the tools
necessary to build and test CHIP. This can take some time, but will
necessary to build and test Matter. This can take some time, but will
eventually complete and open up the source tree

## Bootstrapping your source tree (one time)
Expand Down

0 comments on commit e1dd074

Please sign in to comment.