Conversation
alehander92
force-pushed
the
docs-mdbook
branch
2 times, most recently
from
144dec8 to
550ee1e
Compare
3 tasks
alehander92
force-pushed
the
docs-mdbook
branch
from
55e58cc to
094b13c
Compare
alehander92
changed the title
work from several days ago
…e CI docs workflow * for now add them to the devshell: something not working correctly with the shell.nix for me, also a bit easier to just share the same env; (however it's valuable to have a more fine-grained shell for the docs only) * TODO: add deploy for the docs
for now not including the C/C++ manual build docs and the tester docs, as they seem rr-backend specific
…ublic docs also added `just serve-docs`
alehander92
force-pushed
the
docs-mdbook
branch
from
094b13c to
d966b22
Compare
…, addressing Zahary's comments
Madman10K
suggested changes
Mar 12, 2025
Contributor
Madman10K
left a comment
Madman10K
left a comment
There was a problem hiding this comment.
Just some comments. LGTM otherwise. Did not test hosting or deploying it
| @@ -0,0 +1,5 @@ | |||
| ## Lua | |||
|
|
|||
Contributor
Author
There was a problem hiding this comment.
i propose to keep the newlines, if possible: the markdown seems more well structured this way to me, but this might be subjective
| @@ -0,0 +1,7 @@ | |||
| ## Noir | |||
|
|
|||
Contributor
Author
There was a problem hiding this comment.
(same as above)
Contributor
|
For hosting deployment, I also want to check later whether it can also be pushed to our repository's wiki because I want to read docs while still on github and many more users will probably appreciate it too |
alehander92
force-pushed
the
docs-mdbook
branch
from
e75df23 to
f1f3f3b
Compare
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Closing #33 :
mdbook-alertsas a plugin : https://crates.io/crates/mdbook-alertsdocs/experimental-documentationtodocs/bookTODO: how and where to deploy it exactly?