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

Add MdBook Documentation #1249

Merged
9 commits merged into from
Oct 21, 2021
Merged

Add MdBook Documentation #1249

9 commits merged into from
Oct 21, 2021

Conversation

ghost
Copy link

@ghost ghost commented Oct 19, 2021

Summary of changes

Adds a static website for Forest documentation which we can deploy and distribute to users.

Reference issue to close (if applicable)

#1213
#1214

Other information and links

@ghost
Copy link
Author

ghost commented Oct 19, 2021

We will add CI to deploy this MdBook to Github pages in a separate PR. If you want to test out the documentation locally, ensure you have mdbook installed (cargo install mdbook) and run make mdbook.

Copy link
Contributor

@connormullett connormullett left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I love it, very easy to run and serve. Should be great to add to in the future. One thing I'd like to see is the make install command. Just so we don't have to specify ./target/release/forest for each command

Copy link
Contributor

@connormullett connormullett left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Chatted with jorge, resolved requested changes. GTG

@ghost ghost merged commit 35392d4 into main Oct 21, 2021
@ghost ghost deleted the documentation branch October 21, 2021 00:07
@ghost ghost mentioned this pull request Nov 1, 2021
This pull request was closed.
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.

None yet

3 participants