start writing Documentation #20
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
DhruvaG2000
force-pushed
the
add/docs
branch
2 times, most recently
from
8d3d58c to
d80f6d8
Compare
|
I think we should add a link to the documentation folder from the README. |
Done. |
szczys
requested changes
Sep 1, 2022
documentation/variants.md
Outdated
Comment on lines
3
to
5
| **Pre-reqs:** <br> | ||
| - It is most recommended that if you have a highly custom board that even zephyr-RTOS doesn't support yet then you should add support for it first there. | ||
| - You need to satisfy all requirements mentioned in the project's README. |
There was a problem hiding this comment.
This is confusing. Maybe remove Pre-reqs and just write a summary paragraph that indicates:
- Boards already supported by Zephyr can be added to the variants folder as outlined in this documentation
- Custom boards can first by added by following the official Zephyr porting guide. Once completed, continue here by adding a variant for your custom board.
documentation/overlays.md
Outdated
| @@ -0,0 +1,95 @@ | |||
| # How to add board variants | |||
There was a problem hiding this comment.
Do you think this file can be combined with variants.md?
DhruvaG2000
force-pushed
the
add/docs
branch
from
8f4afbc to
780dea0
Compare
szczys
approved these changes
Sep 2, 2022
DhruvaG2000
force-pushed
the
add/docs
branch
from
780dea0 to
9c9cc26
Compare
- specify reqd changes CMakelist - User needs to know that they will have to change the CMakelists of their sample to find their board specific overlay - describe how to make overlays - Add guidance on how to map the Arduio Header in overlay files Also rename Docs to docs to match lower case convention of other folders Signed-off-by: Mike Szczys <[email protected]> Signed-off-by: Dhruva Gole <[email protected]> - create arduino_libs to explain using external libs This page explains how to use an external arduino library with your project Signed-off-by: Dhruva Gole <[email protected]> update README: add Link to docs folder Also add links to both golioth and my blog Signed-off-by: Dhruva Gole <[email protected]> - Update README: add links to the doc mds Helps users to locate documentation more easily Co-authored-by: Mike Szczys <[email protected]> - Be explicit on how to add the source file to the build Signed-off-by: Dhruva Gole <[email protected]>
DhruvaG2000
force-pushed
the
add/docs
branch
from
9c9cc26 to
9780d9d
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Signed-off-by: Dhruva Gole [email protected]