Skip to content

Conversation

@gkellogg
Copy link
Member

@gkellogg gkellogg commented May 31, 2025

The test-manifest HTML generation can extract these from the spec, and generate the HTML with back-references to the relevant part of the spec.

For example, as is done for YAML-LD tests. Note References entry in most test cases that links back to the normative text.

Although a fair amount of work, this can be done with other specs and tests, and becomes valuable for the Implementation Report. Ideally, each test would be referenced by one or more locations in the spec, and each normative statement would reference one or more tests.

(See GitHack rendered version for test details).


Preview | Diff

@gkellogg gkellogg added the spec:editorial Minor change in the specification (markup, typo, informative text; class 1 or 2) label May 31, 2025
gkellogg added a commit that referenced this pull request Jun 3, 2025
@gkellogg gkellogg requested review from afs, domel, niklasl and pchampin June 5, 2025 22:23
Copy link
Member

@TallTed TallTed left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Small stuff

gkellogg added a commit that referenced this pull request Jun 9, 2025
gkellogg and others added 8 commits June 9, 2025 12:23
… feature.

The test-manifest HTML generation can extract these from the spec, and update the HTML with back-references to the relevant part of the spec.

For example, as is done for [YAML-LD tests](https://json-ld.github.io/yaml-ld/tests/manifest.html). Note References entry in most test cases that links back to the normative text.

Although a fair amount of work, this can be done with other specs and tests, and becomes valuable for the Implementation Report. Ideally, each test would be referenced by one or more locations in the spec, and each normative statement would reference one or more tests.
…erence and change data-tests entries to use .. relative pathing, where necessary.
Co-authored-by: Ted Thibodeau Jr <[email protected]>
Co-authored-by: Ted Thibodeau Jr <[email protected]>
@gkellogg gkellogg merged commit 4c3a862 into main Jun 9, 2025
2 checks passed
@gkellogg gkellogg deleted the test-links branch June 9, 2025 21:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

spec:editorial Minor change in the specification (markup, typo, informative text; class 1 or 2)

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants