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

More guide improvements, chapters 6-7 #226

Merged
merged 4 commits into from
Feb 10, 2022

Conversation

rMazeiks
Copy link
Contributor

Removed duplicated/outdated information; moved things about for better structure. Improved docs for readability & conciseness. Some typo fixes.

@codecov
Copy link

codecov bot commented Feb 10, 2022

Codecov Report

Merging #226 (f5907a6) into master (67766c7) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master     #226   +/-   ##
=======================================
  Coverage   37.21%   37.21%           
=======================================
  Files          67       67           
  Lines        4845     4845           
=======================================
  Hits         1803     1803           
  Misses       3042     3042           

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 67766c7...f5907a6. Read the comment docs.

@cryptoquick
Copy link

How is the guide generated?

@jkelleyrtp
Copy link
Member

Removed duplicated/outdated information; moved things about for better structure. Improved docs for readability & conciseness. Some typo fixes.

This looks great! I will merge here in just a sec if you think this is good to go.

How is the guide generated?

Currently it's been hand-deployed but we have a proof-of-concept of autodeploy on another repo in the org. We use mdbook to build the static assets.

@cryptoquick
Copy link

How is the guide generated?

Currently it's been hand-deployed but we have a proof-of-concept of autodeploy on another repo in the org. We use mdbook to build the static assets.

Perfect! I just wanted to try it out locally, so I can develop using the latest docs.

@rMazeiks
Copy link
Contributor Author

Install mdBook, then compile:

mdbook build docs/guide/

You can pass --open to open it in the browser.

@jkelleyrtp jkelleyrtp merged commit 7f4474e into DioxusLabs:master Feb 10, 2022
@jkelleyrtp
Copy link
Member

I'm going to get an autodeploy of docs going here in a bit and then we'll have a "nightly" and a "released" flavor. All these new additions will go under the "nightly" flavor until 0.2 is released (hopefully as soon as EOW if possible).

@cryptoquick
Copy link

Perfect, thanks @rMazeiks! I got it working with mdbook serve docs/guide/ because xdg-mime inconveniently opened the docs in VS code. Anyway, good work, and thanks again!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants