Documentation suggestions #59
Merged
Conversation
This file contains 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
aentinger
reviewed
Mar 3, 2022
aentinger
reviewed
Mar 3, 2022
aentinger
reviewed
Mar 3, 2022
aentinger
reviewed
Mar 15, 2022
aentinger
reviewed
Mar 15, 2022
aentinger
reviewed
Mar 15, 2022
aentinger
reviewed
Mar 15, 2022
aentinger
reviewed
Mar 15, 2022
aentinger
reviewed
Mar 15, 2022
aentinger
reviewed
Mar 15, 2022
aentinger
reviewed
Mar 15, 2022
aentinger
reviewed
Mar 15, 2022
aentinger
reviewed
Mar 15, 2022
aentinger
reviewed
Mar 15, 2022
aentinger
reviewed
Mar 15, 2022
aentinger
reviewed
Mar 15, 2022
aentinger
reviewed
Mar 15, 2022
aentinger
reviewed
Mar 15, 2022
aentinger
reviewed
Mar 15, 2022
aentinger
reviewed
Mar 15, 2022
aentinger
reviewed
Mar 15, 2022
aentinger
reviewed
Mar 15, 2022
aentinger
reviewed
Mar 15, 2022
aentinger
reviewed
Mar 15, 2022
There was a problem hiding this comment.
Thank you @sebromero. Your input is very helpful. I made some suggestions, a lot of them are because of left-over extraneous spaces, sometimes it looks like you made a search/replace (i.e. for source, because I found many source diffs in the PR 🤷 ).
Regardless, I believe when you've worked through/applied my suggestions we are pretty close to merging this PR and the documentation will be so much better for it. Thank you very much for your through effort 🙇 ❤️ .
aentinger
added
topic: documentation
Co-authored-by: Alexander Entinger <consulting@lxrobotics.com>
Co-authored-by: Alexander Entinger <consulting@lxrobotics.com>
Co-authored-by: Alexander Entinger <consulting@lxrobotics.com>
Co-authored-by: Alexander Entinger <consulting@lxrobotics.com>
Co-authored-by: Alexander Entinger <consulting@lxrobotics.com>
Co-authored-by: Alexander Entinger <consulting@lxrobotics.com>
Co-authored-by: Alexander Entinger <consulting@lxrobotics.com>
Co-authored-by: Alexander Entinger <consulting@lxrobotics.com>
Co-authored-by: Alexander Entinger <consulting@lxrobotics.com>
Co-authored-by: Alexander Entinger <consulting@lxrobotics.com>
Co-authored-by: Alexander Entinger <consulting@lxrobotics.com>
Co-authored-by: Alexander Entinger <consulting@lxrobotics.com>
Co-authored-by: Alexander Entinger <consulting@lxrobotics.com>
Co-authored-by: Alexander Entinger <consulting@lxrobotics.com>
Co-authored-by: Alexander Entinger <consulting@lxrobotics.com>
Co-authored-by: Alexander Entinger <consulting@lxrobotics.com>
Co-authored-by: Alexander Entinger <consulting@lxrobotics.com>
Co-authored-by: Alexander Entinger <consulting@lxrobotics.com>
Co-authored-by: Alexander Entinger <consulting@lxrobotics.com>
Co-authored-by: Alexander Entinger <consulting@lxrobotics.com>
aentinger
force-pushed
the
doc-suggestions
branch
from
f267cf2
to
c7aa0fa
Compare
|
Hi @sebromero ☕ 👋 I've fixed the merge conflicts 😉 Are you going to do future changes or can I merge this PR? |
|
Hi @aentinger 👋 Please have a look at my suggestions above. Once we resolve those, we can merge imo and open a new PR if necessary. 👍 |
aentinger
added a commit
that referenced
this pull request
Jun 8, 2022
* Add questions and suggestions to main readme * Add questions and suggestions to the main docs readme * Add numbers to toc * Add introduction about single-thread limitations * Add reference to example * Add Caveats section * Rephrase benefits paragraph * Add note about single threaded example * Add question about multi core * Perform minor rewording * Add recommendation for naming * Add questions, comments and rephrasing to data exchange * Add note about hierarchy graphic * Add rephrasings and questions to Thread-safe serial * Add rewording and questions to threadsafe wire * Add questions, comments and rephrasing to threadsafe SPI * Clarify on comment * Explain threading and blocking * Remove questions * Update docs/01-threading-basics.md Co-authored-by: Alexander Entinger <consulting@lxrobotics.com> * Update docs/01-threading-basics.md Co-authored-by: Alexander Entinger <consulting@lxrobotics.com> * Update docs/01-threading-basics.md Co-authored-by: Alexander Entinger <consulting@lxrobotics.com> * Update README.md Co-authored-by: Alexander Entinger <consulting@lxrobotics.com> * Update docs/01-threading-basics.md Co-authored-by: Alexander Entinger <consulting@lxrobotics.com> * Update docs/02-data-exchange.md Co-authored-by: Alexander Entinger <consulting@lxrobotics.com> * Update docs/02-data-exchange.md Co-authored-by: Alexander Entinger <consulting@lxrobotics.com> * Update docs/02-data-exchange.md Co-authored-by: Alexander Entinger <consulting@lxrobotics.com> * Update docs/02-data-exchange.md Co-authored-by: Alexander Entinger <consulting@lxrobotics.com> * Update docs/02-data-exchange.md Co-authored-by: Alexander Entinger <consulting@lxrobotics.com> * Update docs/02-data-exchange.md Co-authored-by: Alexander Entinger <consulting@lxrobotics.com> * Update docs/02-data-exchange.md Co-authored-by: Alexander Entinger <consulting@lxrobotics.com> * Update docs/02-data-exchange.md Co-authored-by: Alexander Entinger <consulting@lxrobotics.com> * Update docs/05-threadsafe-spi.md Co-authored-by: Alexander Entinger <consulting@lxrobotics.com> * Update docs/04-threadsafe-wire.md Co-authored-by: Alexander Entinger <consulting@lxrobotics.com> * Update docs/05-threadsafe-spi.md Co-authored-by: Alexander Entinger <consulting@lxrobotics.com> * Update docs/05-threadsafe-spi.md Co-authored-by: Alexander Entinger <consulting@lxrobotics.com> * Update docs/05-threadsafe-spi.md Co-authored-by: Alexander Entinger <consulting@lxrobotics.com> * Update docs/README.md Co-authored-by: Alexander Entinger <consulting@lxrobotics.com> * Update docs/05-threadsafe-spi.md Co-authored-by: Alexander Entinger <consulting@lxrobotics.com> * Update docs/01-threading-basics.md * Update docs/02-data-exchange.md Co-authored-by: Alexander Entinger <consulting@lxrobotics.com>
aentinger
added a commit
that referenced
this pull request
Jun 8, 2022
* Adding documentation for threading basics. * Adding documentation for Shared/Sink/Source semantics. * Adding documentation for threadsafe Serial. * Adding documentation for threadsafe Wire. * Adding download link for multi-threading supporting arduino-cli. * Adding documentation for threadsafe SPI. * Adding download links for all platforms. * Fix: a arduino sketch can contain multiple ino-files, not just a single one. (But you can only define setup/loop once. See #57 (comment). * Adding information on limitation of inot-file names. * Documentation suggestions (#59) * Add questions and suggestions to main readme * Add questions and suggestions to the main docs readme * Add numbers to toc * Add introduction about single-thread limitations * Add reference to example * Add Caveats section * Rephrase benefits paragraph * Add note about single threaded example * Add question about multi core * Perform minor rewording * Add recommendation for naming * Add questions, comments and rephrasing to data exchange * Add note about hierarchy graphic * Add rephrasings and questions to Thread-safe serial * Add rewording and questions to threadsafe wire * Add questions, comments and rephrasing to threadsafe SPI * Clarify on comment * Explain threading and blocking * Remove questions * Update docs/01-threading-basics.md Co-authored-by: Alexander Entinger <consulting@lxrobotics.com> * Update docs/01-threading-basics.md Co-authored-by: Alexander Entinger <consulting@lxrobotics.com> * Update docs/01-threading-basics.md Co-authored-by: Alexander Entinger <consulting@lxrobotics.com> * Update README.md Co-authored-by: Alexander Entinger <consulting@lxrobotics.com> * Update docs/01-threading-basics.md Co-authored-by: Alexander Entinger <consulting@lxrobotics.com> * Update docs/02-data-exchange.md Co-authored-by: Alexander Entinger <consulting@lxrobotics.com> * Update docs/02-data-exchange.md Co-authored-by: Alexander Entinger <consulting@lxrobotics.com> * Update docs/02-data-exchange.md Co-authored-by: Alexander Entinger <consulting@lxrobotics.com> * Update docs/02-data-exchange.md Co-authored-by: Alexander Entinger <consulting@lxrobotics.com> * Update docs/02-data-exchange.md Co-authored-by: Alexander Entinger <consulting@lxrobotics.com> * Update docs/02-data-exchange.md Co-authored-by: Alexander Entinger <consulting@lxrobotics.com> * Update docs/02-data-exchange.md Co-authored-by: Alexander Entinger <consulting@lxrobotics.com> * Update docs/02-data-exchange.md Co-authored-by: Alexander Entinger <consulting@lxrobotics.com> * Update docs/05-threadsafe-spi.md Co-authored-by: Alexander Entinger <consulting@lxrobotics.com> * Update docs/04-threadsafe-wire.md Co-authored-by: Alexander Entinger <consulting@lxrobotics.com> * Update docs/05-threadsafe-spi.md Co-authored-by: Alexander Entinger <consulting@lxrobotics.com> * Update docs/05-threadsafe-spi.md Co-authored-by: Alexander Entinger <consulting@lxrobotics.com> * Update docs/05-threadsafe-spi.md Co-authored-by: Alexander Entinger <consulting@lxrobotics.com> * Update docs/README.md Co-authored-by: Alexander Entinger <consulting@lxrobotics.com> * Update docs/05-threadsafe-spi.md Co-authored-by: Alexander Entinger <consulting@lxrobotics.com> * Update docs/01-threading-basics.md * Update docs/02-data-exchange.md Co-authored-by: Alexander Entinger <consulting@lxrobotics.com> Co-authored-by: Sebastian Romero <s.romero.zh@gmail.com>
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.
@aentinger I've added my suggestions in this pull request. It's a mix of corrected typos, rephrasings and amendments.