tree: 2603dae9d1964d9fcd57e21d6d13d06ac1079198 [path history] [tgz]
  1. _extensions/
  2. _static/
  3. api/
  4. ci-cd/
  5. cluster_and_device_type_dev/
  6. discussion/
  7. dots/
  8. examples/
  9. getting_started/
  10. guides/
  11. images/
  12. style/
  13. testing/
  14. tools/
  15. BUG_REPORT.md
  16. ChipDoxygenLayout.xml
  17. code_generation.md
  18. conf.py
  19. Doxyfile
  20. ERROR_CODES.md
  21. index.md
  22. make.bat
  23. Makefile
  24. namespaces.dox
  25. PROJECT_FLOW.md
  26. QUICK_START.md
  27. README.md
  28. requirements.txt
  29. spec_clusters.md
  30. VSCODE_DEVELOPMENT.md
  31. zap_clusters.md
docs/README.md

Documentation

Building and Developing

Platform Guides

  • Various guides are available here that cover platform bring up, testing, and various troubleshooting things.

Project Flow

  • Documentation about general project usage of GitHub, and project tools is documented in the project flow

Style Guide

Third Party Tools

Some tools and utilities are dependent on third party tools, such as Docker.

Docker is an excellent way to have stable build environments that don't pollute the host OS. It is also much easier to maintain stability across multiple host environments. Install stable version of Docker Desktop relevant to your native OS (macOS or Windows). Once installed, you can run docker commands from the shell/terminal.