docs: Usage section#851
Conversation
I wrote the usage section I hoped would have been there when I started using Weaver. I focused on describing the core concepts and functionality involved when using Weaver to generate code, which imo is the most likely thing someone will attempt first in their schematized telemetry journey. The new Usage section of the README consolidates the previous documentation section with added docs in such a way that introduced concepts build onto each other. I did not aim for completeness. Existing reference documentation is just fine, but is now hopefully more easily approachable for newcomers
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #851 +/- ##
=====================================
Coverage 76.9% 77.0%
=====================================
Files 76 76
Lines 5768 5768
=====================================
+ Hits 4441 4442 +1
+ Misses 1327 1326 -1 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
jsuereth
left a comment
There was a problem hiding this comment.
Really love this PR!
Definitely love the documentation around how template generation works. I would like to preserve some of the existing references, but I think this is overall another big improvement like the previous one from @jerbly.
lquerel
left a comment
There was a problem hiding this comment.
Thank you very much for these improvements to the documentation!
In my opinion, there are a few minor changes to be made that I have noted in my comments. Apart from these points to address, I think this PR is ready to go.
I wrote the usage section I hoped would have been there when I started using Weaver.
I focused on describing the core concepts and functionality involved when using Weaver to generate code, which imo is the most likely thing someone will attempt first in their schematized telemetry journey.
The new Usage section of the README consolidates the previous documentation section with added docs in such a way that introduced concepts build onto each other.
I did not aim for completeness. Existing reference documentation is just fine, but is now hopefully more easily approachable for newcomers