Skip to content
This repository has been archived by the owner on Nov 29, 2022. It is now read-only.

docs(guide): Add a quickstart section #70

Merged
merged 3 commits into from
Mar 20, 2021
Merged

Conversation

faassen
Copy link
Contributor

@faassen faassen commented Mar 16, 2021

I've written a very basic quickstart. I've ensured this code actually works so you can copy and paste it.

mdBook automatically adds a "run" button that doesn't work for me - perhaps we need to find a way to disable it if we can't make it work.

I've also added a features.md document which is just a todo list for other things I intend to write about.

To ensure full code examples work we could try to figure out how to set up a sub-package and then include the code directly using the mdBook #include directive. I could place the code in the examples directory of the main package, but perhaps there's a better place.

@faassen
Copy link
Contributor Author

faassen commented Mar 16, 2021

There are some test failures I do not comprehend - it appears it cannot compile the code in it, and this code actually does work so it must be some dependency setup that is missing?

@jcornaz
Copy link
Owner

jcornaz commented Mar 17, 2021

Great, thanks.

mdbook test doesn't work because of the third party dependencies. see rust-lang/mdBook#706

So I use rust-skeptic to test the documentation. It has some limitations that usual rust doc doesn't have:

  1. The examples need a main function (by default)
  2. You may have to explicitly recompile cargo build (If you still have problem try removing the target folder)

I'll have a look at it tonight. Thanks for the help!

@jcornaz jcornaz changed the title Add a quickstart to the guide. docs(guide): Add a quickstart section Mar 17, 2021
@jcornaz
Copy link
Owner

jcornaz commented Mar 17, 2021

@faassen That example requires the "full" bevy engine and needs to render graphics on screen. This kind of example can be tagged no_run so that they are checked for compilation, but are not executed.

Copy link
Owner

@jcornaz jcornaz left a comment

Choose a reason for hiding this comment

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

This is a good start for the guide, thanks!

I removed the "feature" file which is more a todo-list of what to add to the guide. And I moved that todo-list into an issue (#71)

@faassen
Copy link
Contributor Author

faassen commented Mar 17, 2021

Thanks, that fixes the few items I was blocked on. I will try to find time to write some more later.

@faassen
Copy link
Contributor Author

faassen commented Mar 19, 2021

Nothing appears to be blocking a merge now, I think. Just for clarification: further text will arrive in the form of future PRs.

@jcornaz jcornaz merged commit b80f644 into jcornaz:main Mar 20, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants