chore(book): first Logo's handbook version #319

jeertmans · 2023-06-25T16:54:25Z

I have finally completed the book with all the information I felt important.

Even though building the book on the book branch 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 rebase commands if everything is in one branch, i.e., the master one. The master branch will also benefit from the new examples I added to document the book, that will be scraped by docs.rs for... 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/.

* 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 <[email protected]>

* 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 <[email protected]> Co-authored-by: Marcin Wojnarowski <[email protected]>

* 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 <[email protected]> Co-authored-by: Marcin Wojnarowski <[email protected]>

* chore(book): document extras Hey! This small PR adds an example for `Extras` and documents it in the book. * chore(examples): fix typo