Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Documentation: more handbook re-org #36208

Merged
merged 7 commits into from
Oct 29, 2024
Merged

Documentation: more handbook re-org #36208

merged 7 commits into from
Oct 29, 2024

Conversation

cecille
Copy link
Contributor

@cecille cecille commented Oct 23, 2024

  • move zap and codegen info into its own dir
  • add info about how to test device conformance after changing examples
  • move ID and codes files into their own subdir

@semanticdiff-com SemanticDiff.com
Copy link

semanticdiff-com bot commented Oct 23, 2024 •
edited
Loading

Review changes with SemanticDiff.

Analyzed 1 of 24 files.

File Information
Filename Status
❔ .restyled.yaml Unsupported file format
❔ .spellcheck.yml Unsupported file format
✔️ scripts/tools/zap_regen_all.py Analyzed
❔ docs/index.md Unsupported file format
❔ docs/zap_and_codegen/code_generation.md Unsupported file format
❔ docs/zap_and_codegen/index.md Unsupported file format
❔ docs/zap_and_codegen/zap_intro.md Unsupported file format
❔ docs/zap_and_codegen/img/zap1.png Unsupported file format
❔ docs/zap_and_codegen/img/zap2.png Unsupported file format
❔ docs/zap_and_codegen/img/zap3.png Unsupported file format
❔ docs/zap_and_codegen/img/zap4.png Unsupported file format
❔ docs/zap_and_codegen/img/zap5.png Unsupported file format
❔ docs/zap_and_codegen/img/zap6.png Unsupported file format
❔ docs/zap_and_codegen/img/zap_compiler.png Unsupported file format
❔ docs/ids_and_codes/ERROR_CODES.md Unsupported file format
❔ docs/ids_and_codes/index.md Unsupported file format
❔ docs/ids_and_codes/spec_clusters.md Unsupported file format
❔ docs/ids_and_codes/zap_clusters.md Unsupported file format
❔ docs/guides/simulated_device_linux.md Unsupported file format
❔ docs/getting_started/changing_examples.md Unsupported file format
❔ docs/getting_started/first_example.md Unsupported file format
❔ docs/getting_started/index.md Unsupported file format
❔ docs/cluster_and_device_type_dev/cluster_and_device_type_dev.md Unsupported file format
❔ .github/workflows/zap_templates.yaml Unsupported file format

@github-actions github-actions bot added the documentation Improvements or additions to documentation label Oct 23, 2024
Vyrastas
Vyrastas approved these changes Oct 23, 2024
View reviewed changes
Copy link
Contributor

@Vyrastas Vyrastas left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

One copyedit nit

@mergify mergify bot merged commit b25200a into project-chip:master Oct 29, 2024
69 checks passed
yyzhong-g pushed a commit to yyzhong-g/connectedhomeip that referenced this pull request Dec 12, 2024
@cecille @andy31415
@Vyrastas @yyzhong-g
Documentation: more handbook re-org (project-chip#36208)
c1a5cf4 
* Documentation: gather IDs and codes into dir

* Documentation: Consolidate zap/codegen

* Update docs/getting_started/changing_examples.md

Co-authored-by: Jeff Bumgardner <[email protected]>

* Fix a couple of missed doc refs

* Fix some paths for the CI checkers

* Not sure why it's not finding this on the CI

* fix zap output directory

---------

Co-authored-by: Andrei Litvin <[email protected]>
Co-authored-by: Jeff Bumgardner <[email protected]>
@lboue lboue mentioned this pull request Dec 15, 2024
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@arkq arkq arkq approved these changes

@Vyrastas Vyrastas Vyrastas approved these changes

@andy31415 andy31415 andy31415 approved these changes

Assignees
No one assigned
Labels
documentation Improvements or additions to documentation github review - approved scripts workflows
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@cecille @andy31415 @Vyrastas @arkq