Rewrite the docs #389
Merged
Rewrite the docs #389
Conversation
This file contains 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
timholy
commented
Jul 23, 2024
|
You can click on the |
|
Hmm, Documenter seems like it might have trouble until we register this 😢 . Specifically, the lines in the documentation that encourage you to |
|
OK, should be working now. Thanks to @asinghvi17! |
Switches from darts to blackjack. There were several features about the darts example that made for poor teaching, including the gap between `@enum` and a `struct` and the artificiality of not extending the base package. Also polishes the explanations and improves how things are named.
This is intended to encourage users to collect data with just SnoopCompileCore.
|
OK, I think this is finally ready. I anticipate merging and releasing SnoopCompile 3.0.0 later today. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This aims to rewrite the documentation loosely in the style advocated by divio.
It acknowledges the existence of PrecompileTools and focuses on how you use SnoopCompile to understand why precompilation isn't working the way you'd like.