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.

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

[Documentation] CHEF test devices example doc listed under guides #28354

Open
greg-fer opened this issue Jul 28, 2023 · 1 comment
Open

[Documentation] CHEF test devices example doc listed under guides #28354

greg-fer opened this issue Jul 28, 2023 · 1 comment
Labels
documentation Improvements or additions to documentation needs triage

Comments

@greg-fer
Copy link
Contributor

greg-fer commented Jul 28, 2023

Documentation issues

The PR #27900 introduced a new CHEF text device example with related documentation.
There are two issues with this PR's documentation:

  1. The example documentation README.md is accompanied by a user guide NEW_CHEF_DEVICES.md in the example directory.
  2. The README.md for the example is mentioned in docs/guides/index.md instead of examples/index.md

These issues are causing inconsistencies in the doc structure and can lead to more serious discrepancies in the future if more PRs use #27900 as example.

Please fix these issues as follows:

  • For 1., place the user guide under docs/guides and link it correctly in docs/guides/index.md. Make sure that the guide is pointing to the example. You can use the CHIP Tool guide's Source files section as example, where we point to the CHIP Tool example.
  • For 2., remove the reference to the README.md from the guides section and add the mention of the example to examples/index.md.
  • For both 1 and 2, reworking of both documents might be needed, so that they are complete on their own and cross-link adequately.

Platform

other

Anything else?

No response

@greg-fer greg-fer added documentation Improvements or additions to documentation needs triage labels Jul 28, 2023
@greg-fer
Copy link
Contributor Author

@andy31415 , could you please fix this?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation needs triage
Projects
None yet
Development

No branches or pull requests

1 participant