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.

Sign up for GitHub

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

Jump to bottom

Examples Validation #1851

Open
egekorkan opened this issue Jul 12, 2023 · 2 comments
Open

Examples Validation #1851

egekorkan opened this issue Jul 12, 2023 · 2 comments
Labels
Defer to TD 2.0 document reorganization discussions on how to better structure the specification document

Comments

@egekorkan
Copy link
Contributor

To avoid cases like #1845, we should have validation (including semantic validation) of all our examples.
@github-actions github-actions bot added the needs-triage Automatically added to new issues. TF should triage them with proper labels label Jul 12, 2023
@egekorkan egekorkan added by REC publication Defer to TD 2.0 and removed needs-triage Automatically added to new issues. TF should triage them with proper labels by REC publication labels Jul 12, 2023
@JKRhb
Copy link
Member

JKRhb commented Jul 15, 2023

I suppose in order to do so, we would need to put the examples into external files and then include them via ReSpec, right? Or could the validation also be performed on JSON embedded within the HTML document?

@egekorkan
Copy link
Contributor Author

I would imagine an approach like the first one. However, we need to find a solution to have full JSONs to run validation on but at the same time show only the relevant part of the example in the specification text.

@egekorkan egekorkan mentioned this issue Aug 8, 2023
Merged
@mjkoster mjkoster added the document reorganization discussions on how to better structure the specification document label Feb 8, 2024
@egekorkan egekorkan mentioned this issue Mar 13, 2024
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Defer to TD 2.0 document reorganization discussions on how to better structure the specification document
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@mjkoster @JKRhb @egekorkan