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

Adding documentation. #57

Merged
merged 10 commits into from Jun 8, 2022
Merged

Adding documentation. #57

merged 10 commits into from Jun 8, 2022

Conversation

aentinger
Copy link
Contributor

No description provided.

aentinger added a commit that referenced this pull request Dec 21, 2021
…le one.

(But you can only define setup/loop once.
See #57 (comment).
aentinger added a commit that referenced this pull request Mar 28, 2022
…le one.

(But you can only define setup/loop once.
See #57 (comment).
@per1234 per1234 added the topic: documentation Related to documentation for the project label Mar 28, 2022
@aentinger aentinger marked this pull request as ready for review June 8, 2022 09:21
aentinger and others added 10 commits June 8, 2022 12:05
…le one.

(But you can only define setup/loop once.
See #57 (comment).
* 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 aentinger deleted the doc branch June 8, 2022 10:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
topic: documentation Related to documentation for the project type: enhancement Proposed improvement
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants