Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

KDL examples to go with KDL schema example(s) #251

Open
micahsnyder opened this issue Nov 7, 2021 · 1 comment
Open

KDL examples to go with KDL schema example(s) #251

micahsnyder opened this issue Nov 7, 2021 · 1 comment
Labels
documentation Improvements or additions to documentation help wanted Extra attention is needed

Comments

@micahsnyder
Copy link

The example schema at https://github.com/kdl-org/kdl/blob/main/examples/kdl-schema.kdl would be easier to grok if there were a corresponding kdl file or two that fits the schema. It could maybe go at the top of the schema in a comment block for easy reference.

It would be even better if we could add some markdown documentation with schema/kdl examples in pairs.

I'm only just starting to play with KDL so I'm not able to contribute this myself (yet).

@boringcactus
Copy link
Contributor

boringcactus commented Mar 28, 2022

That schema corresponds to the KDL Schema specification, so the document that fits that schema is itself.

@zkat zkat added documentation Improvements or additions to documentation help wanted Extra attention is needed labels Nov 28, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

3 participants