chore(book): first Logo's handbook version #319
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
* Initial commit for the Logos Handboook * A bit more adds to the book * chore(ci): setup automated CI for book * chore(ci): update branches * fix(ci): remove extra needs --------- Co-authored-by: Maciej Hirsz <hello@maciej.codes>
* Initial commit for the Logos Handboook * A bit more adds to the book * chore(ci): setup automated CI for book * chore(ci): update branches * fix(ci): remove extra needs * chore(docs): adding brainfuck example * Add missing `Debug` error type requirement (#298) * chore(docs): create JSON example * Initial commit for the Logos Handboook * A bit more adds to the book * chore(ci): setup automated CI for book * chore(ci): update branches * fix(ci): remove extra needs * chore(docs): adding brainfuck example * chore(docs): create JSON example * chore(ci): test code examples * chore(docs): scrape examples and autodoc features * chore(docs): adding brainfuck example * Add missing `Debug` error type requirement (#298) * chore(docs): create JSON example * chore(ci): test code examples * chore(docs): scrape examples and autodoc features * Auto stash before rebase of "maciejhirsz/book" * chore(book): typos and styling --------- Co-authored-by: Maciej Hirsz <hello@maciej.codes> Co-authored-by: Marcin Wojnarowski <xmarcinmarcin@gmail.com>
* Initial commit for the Logos Handboook * A bit more adds to the book * chore(ci): setup automated CI for book * chore(ci): update branches * fix(ci): remove extra needs * chore(docs): adding brainfuck example * Add missing `Debug` error type requirement (#298) * chore(docs): create JSON example * Initial commit for the Logos Handboook * A bit more adds to the book * chore(ci): setup automated CI for book * chore(ci): update branches * fix(ci): remove extra needs * chore(docs): adding brainfuck example * chore(docs): create JSON example * chore(ci): test code examples * chore(docs): scrape examples and autodoc features * chore(docs): adding brainfuck example * Add missing `Debug` error type requirement (#298) * chore(docs): create JSON example * chore(ci): test code examples * chore(docs): scrape examples and autodoc features * Auto stash before rebase of "maciejhirsz/book" * chore(book): typos and styling * chore(lib/book): more lib's doc to book Hello, This PR proposes to move all the documentation-related content to the book, so that everything is documented in one place. This will prevent future errors that occur when the same content must be update in multiple places. The book is not finished yet though :-) * try(ci): fixing github pages * fix(ci): fix book path * fix(ci): reset branch --------- Co-authored-by: Maciej Hirsz <hello@maciej.codes> Co-authored-by: Marcin Wojnarowski <xmarcinmarcin@gmail.com>
* chore(book): document extras Hey! This small PR adds an example for `Extras` and documents it in the book. * chore(examples): fix typo
* Initial commit for the Logos Handboook * A bit more adds to the book * chore(ci): setup automated CI for book * chore(ci): update branches * fix(ci): remove extra needs --------- Co-authored-by: Maciej Hirsz <hello@maciej.codes>
* Initial commit for the Logos Handboook * A bit more adds to the book * chore(ci): setup automated CI for book * chore(ci): update branches * fix(ci): remove extra needs * chore(docs): adding brainfuck example * Add missing `Debug` error type requirement (#298) * chore(docs): create JSON example * Initial commit for the Logos Handboook * A bit more adds to the book * chore(ci): setup automated CI for book * chore(ci): update branches * fix(ci): remove extra needs * chore(docs): adding brainfuck example * chore(docs): create JSON example * chore(ci): test code examples * chore(docs): scrape examples and autodoc features * chore(docs): adding brainfuck example * Add missing `Debug` error type requirement (#298) * chore(docs): create JSON example * chore(ci): test code examples * chore(docs): scrape examples and autodoc features * Auto stash before rebase of "maciejhirsz/book" * chore(book): typos and styling --------- Co-authored-by: Maciej Hirsz <hello@maciej.codes> Co-authored-by: Marcin Wojnarowski <xmarcinmarcin@gmail.com>
* Initial commit for the Logos Handboook * A bit more adds to the book * chore(ci): setup automated CI for book * chore(ci): update branches * fix(ci): remove extra needs * chore(docs): adding brainfuck example * Add missing `Debug` error type requirement (#298) * chore(docs): create JSON example * Initial commit for the Logos Handboook * A bit more adds to the book * chore(ci): setup automated CI for book * chore(ci): update branches * fix(ci): remove extra needs * chore(docs): adding brainfuck example * chore(docs): create JSON example * chore(ci): test code examples * chore(docs): scrape examples and autodoc features * chore(docs): adding brainfuck example * Add missing `Debug` error type requirement (#298) * chore(docs): create JSON example * chore(ci): test code examples * chore(docs): scrape examples and autodoc features * Auto stash before rebase of "maciejhirsz/book" * chore(book): typos and styling * chore(lib/book): more lib's doc to book Hello, This PR proposes to move all the documentation-related content to the book, so that everything is documented in one place. This will prevent future errors that occur when the same content must be update in multiple places. The book is not finished yet though :-) * try(ci): fixing github pages * fix(ci): fix book path * fix(ci): reset branch --------- Co-authored-by: Maciej Hirsz <hello@maciej.codes> Co-authored-by: Marcin Wojnarowski <xmarcinmarcin@gmail.com>
* chore(book): document extras Hey! This small PR adds an example for `Extras` and documents it in the book. * chore(examples): fix typo
* Initial commit for the Logos Handboook * A bit more adds to the book * chore(ci): setup automated CI for book * chore(ci): update branches * fix(ci): remove extra needs --------- Co-authored-by: Maciej Hirsz <hello@maciej.codes>
* Initial commit for the Logos Handboook * A bit more adds to the book * chore(ci): setup automated CI for book * chore(ci): update branches * fix(ci): remove extra needs * chore(docs): adding brainfuck example * Add missing `Debug` error type requirement (#298) * chore(docs): create JSON example * Initial commit for the Logos Handboook * A bit more adds to the book * chore(ci): setup automated CI for book * chore(ci): update branches * fix(ci): remove extra needs * chore(docs): adding brainfuck example * chore(docs): create JSON example * chore(ci): test code examples * chore(docs): scrape examples and autodoc features * chore(docs): adding brainfuck example * Add missing `Debug` error type requirement (#298) * chore(docs): create JSON example * chore(ci): test code examples * chore(docs): scrape examples and autodoc features * Auto stash before rebase of "maciejhirsz/book" * chore(book): typos and styling --------- Co-authored-by: Maciej Hirsz <hello@maciej.codes> Co-authored-by: Marcin Wojnarowski <xmarcinmarcin@gmail.com>
* Initial commit for the Logos Handboook * A bit more adds to the book * chore(ci): setup automated CI for book * chore(ci): update branches * fix(ci): remove extra needs * chore(docs): adding brainfuck example * Add missing `Debug` error type requirement (#298) * chore(docs): create JSON example * Initial commit for the Logos Handboook * A bit more adds to the book * chore(ci): setup automated CI for book * chore(ci): update branches * fix(ci): remove extra needs * chore(docs): adding brainfuck example * chore(docs): create JSON example * chore(ci): test code examples * chore(docs): scrape examples and autodoc features * chore(docs): adding brainfuck example * Add missing `Debug` error type requirement (#298) * chore(docs): create JSON example * chore(ci): test code examples * chore(docs): scrape examples and autodoc features * Auto stash before rebase of "maciejhirsz/book" * chore(book): typos and styling * chore(lib/book): more lib's doc to book Hello, This PR proposes to move all the documentation-related content to the book, so that everything is documented in one place. This will prevent future errors that occur when the same content must be update in multiple places. The book is not finished yet though :-) * try(ci): fixing github pages * fix(ci): fix book path * fix(ci): reset branch --------- Co-authored-by: Maciej Hirsz <hello@maciej.codes> Co-authored-by: Marcin Wojnarowski <xmarcinmarcin@gmail.com>
* chore(book): document extras Hey! This small PR adds an example for `Extras` and documents it in the book. * chore(examples): fix typo
* Initial commit for the Logos Handboook * A bit more adds to the book * chore(ci): setup automated CI for book * chore(ci): update branches * fix(ci): remove extra needs --------- Co-authored-by: Maciej Hirsz <hello@maciej.codes>
* Initial commit for the Logos Handboook * A bit more adds to the book * chore(ci): setup automated CI for book * chore(ci): update branches * fix(ci): remove extra needs * chore(docs): adding brainfuck example * Add missing `Debug` error type requirement (#298) * chore(docs): create JSON example * Initial commit for the Logos Handboook * A bit more adds to the book * chore(ci): setup automated CI for book * chore(ci): update branches * fix(ci): remove extra needs * chore(docs): adding brainfuck example * chore(docs): create JSON example * chore(ci): test code examples * chore(docs): scrape examples and autodoc features * chore(docs): adding brainfuck example * Add missing `Debug` error type requirement (#298) * chore(docs): create JSON example * chore(ci): test code examples * chore(docs): scrape examples and autodoc features * Auto stash before rebase of "maciejhirsz/book" * chore(book): typos and styling --------- Co-authored-by: Maciej Hirsz <hello@maciej.codes> Co-authored-by: Marcin Wojnarowski <xmarcinmarcin@gmail.com>
* Initial commit for the Logos Handboook * A bit more adds to the book * chore(ci): setup automated CI for book * chore(ci): update branches * fix(ci): remove extra needs * chore(docs): adding brainfuck example * Add missing `Debug` error type requirement (#298) * chore(docs): create JSON example * Initial commit for the Logos Handboook * A bit more adds to the book * chore(ci): setup automated CI for book * chore(ci): update branches * fix(ci): remove extra needs * chore(docs): adding brainfuck example * chore(docs): create JSON example * chore(ci): test code examples * chore(docs): scrape examples and autodoc features * chore(docs): adding brainfuck example * Add missing `Debug` error type requirement (#298) * chore(docs): create JSON example * chore(ci): test code examples * chore(docs): scrape examples and autodoc features * Auto stash before rebase of "maciejhirsz/book" * chore(book): typos and styling * chore(lib/book): more lib's doc to book Hello, This PR proposes to move all the documentation-related content to the book, so that everything is documented in one place. This will prevent future errors that occur when the same content must be update in multiple places. The book is not finished yet though :-) * try(ci): fixing github pages * fix(ci): fix book path * fix(ci): reset branch --------- Co-authored-by: Maciej Hirsz <hello@maciej.codes> Co-authored-by: Marcin Wojnarowski <xmarcinmarcin@gmail.com>
* chore(book): document extras Hey! This small PR adds an example for `Extras` and documents it in the book. * chore(examples): fix typo
jeertmans
added
book
Codecov Report
❗ Your organization is not using the GitHub App Integration. As a result you may experience degraded service beginning May 15th. Please install the Github App Integration for your organization. Read more. @@ Coverage Diff @@
## master #319 +/- ##
==========================================
- Coverage 20.88% 20.08% -0.81%
==========================================
Files 32 34 +2
Lines 2049 2131 +82
==========================================
Hits 428 428
- Misses 1621 1703 +82
|
|
Benchmark results: |
This was
linked to
issues
Jun 25, 2023
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.
Hi @maciejhirsz!
I have finally completed the book with all the information I felt important.
Even though building the book on the
bookbranch is fine, having two separate "main" branches in active development feels quite tedious to keep up-to-date, especially as some of what is displayed in the book directly depends on the crates' content.Therefore, I think it can reduce the amount of
git rebasecommands if everything is in one branch, i.e., themasterone. Themasterbranch will also benefit from the new examples I added to document the book, that will be scraped bydocs.rsfor... examples! And that are also tested for compilation.I tried to check for spelling and grammar mistakes, but it may not be perfect :'-)
Also, I would gladly take any comment / remark on this.
I prefer that you review this before it is merged onto
master. I understand that it is quite large PR, and reviewing may take some time ^^'.You can directly see the book rendered here: https://logos.maciej.codes/.