Add tracing how-to guide, fix With terminology, update .gitignore#192
Merged
Conversation
- Add comprehensive how-to guide for using NUClear's trace system - Fix With DSL page: describe concepts (get extension point) instead of implementation details (CacheGet class) - Add site/ to .gitignore for MkDocs build output
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
1 participant
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.
Changes
Tracing How-To Guide
Adds a comprehensive how-to guide (
docs2/how-to/tracing.md) covering:BeginTrace/EndTracemessagesFix With DSL Page Terminology
Updates the Notes section of
docs2/reference/dsl/with.mdto describe the conceptual extension point (get) rather than the implementation class (CacheGet).Before: "With uses only CacheGet internally..."
After: "With implements the
getextension point — retrieving the latest value from NUClear's data cache..."Update .gitignore
Adds
site/to.gitignoreto exclude MkDocs build output.Related