spdx-spec icon indicating copy to clipboard operation
spdx-spec copied to clipboard

Use tabbed code blocks to make the spec easier to read

Open letmaik opened this issue 4 years ago • 3 comments

Currently, the spec shows examples in multiple serializations, where typically people are only interested in a single format depending on their use case, in my case this is JSON.

Lots of docs out there which have multiple snippet variants use tabs. Ideally, all tabs are linked, so switching one snippet to JSON switches all of them. I think SPDX would benefit from the same.

For mkdocs, there are extensions for this purpose, an example is shown here: https://squidfunk.github.io/mkdocs-material/reference/content-tabs/#configuration.

letmaik avatar Sep 29 '21 13:09 letmaik

@letmaik Thanks for the pointer to the tabs extension. Note - this is related to issue #162 Since this is a more specific recommendation, I'm going to close #162 as a duplicate of this issue.

goneall avatar Sep 29 '21 17:09 goneall

Still a good idea - but no time to implement in 3.0. Moving to 3.1.

goneall avatar Apr 04 '24 16:04 goneall