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

Hook in new examples, schemas etc into rendering #96

Open
arnoweiss opened this issue Nov 14, 2024 · 0 comments
Open

Hook in new examples, schemas etc into rendering #96

arnoweiss opened this issue Nov 14, 2024 · 0 comments
Labels
enhancement New feature or request triage all new issues awaiting classification

Comments

@arnoweiss
Copy link
Contributor

arnoweiss commented Nov 14, 2024

What's missing?

Currently, the examples in the web rendering are not automatically validated. In a first step we should link to the normative schemas, examples and messages in the artifacts folder.

Why should it be in the spec?

Increases consistency and quality

Where should this be added?

we should add html tags in the markdown files where we want to import examples like

<aside class="example" title="How to use it">
  <p>
    This is how to use it.
  <p>
  <pre class="json" data-include="./artifacts/src/main/resources/context/dcp.jsonld">
  </pre>
</aside>

More context

@jimmarino - can you link the examples you'd specifically like to see in the spec and assign me to this ticket?

@arnoweiss arnoweiss added enhancement New feature or request triage all new issues awaiting classification labels Nov 14, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request triage all new issues awaiting classification
Projects
None yet
Development

No branches or pull requests

1 participant