docs: Add documentation on AST and Cursor #1098
Conversation
docs/decoding.md
Outdated
|
|
||
| To get the AST representation of a JSON string, use the `fromJson[Json]` method. | ||
|
|
||
| ```scala |
There was a problem hiding this comment.
I prefer using compile-safe code snippets to keep the documents up-to-date using mdoc modifiers.
There was a problem hiding this comment.
right... it even says so in the docs contribution guidelines. Sorry, missed that - will update my PR.
There was a problem hiding this comment.
done.
Note that the CI now fails because of an non-up-tp-date README file, which seems to relate to 61b7634
There was a problem hiding this comment.
Note that the CI now fails because of an non-up-tp-date README file, which seems to relate to 61b7634
@BalduinLandolt
Please update the PR from upstream series/2.x branch.
There was a problem hiding this comment.
@khajavi thanks for updating it! Should be good to merge now?
BalduinLandolt
force-pushed
the
wip/add-ast-and-cursor-documentation
branch
from
165c818
to
764325a
Compare
|
@khajavi ping 🙂 |
Co-authored-by: Milad Khajavi <khajavi@gmail.com>
I really like the latest additions to the decoding documentation.
However, I feel that the concepts of the AST and Cursor aren't really introduced/explained to the extent that the examples would make sense for someone who isn't already familiar with the concepts.
I jotted down a little something. But I'm also happy to make changes or see this changed by the maintainers.
Also, since the
decoding.mdpage is getting pretty long, it might be worth changing some of the overall structure of the documentation, maybe with an additional level of page nesting.That's of course not mine to decide, but I'd be happy to contribute to it, if I can.