spdx
Include short examples from AI BOM whitepaper to each class/property
Implementing AI Bill of Materials (AI BOM) with SPDX 3.0 whitepaper contains concise examples of how to use each class and property in AI and Dataset Profiles.
We can include those examples to the "Example" section in the model Markdown files in this repo, so it will be displayed on the generated website as well.
Examples from the whitepaper:
Full examples would probably be placed best in the https://github.com/spdx/spdx-examples repo.
Snippets should probably be placed best in the https://github.com/spdx/using repo.
I don't think they should be in the specification (unless we define a separate section, and we explicitly say that these are not normative).
As examples, they are not normative. This is merely follow examples in Security Profile.
Define a separate section and clearly said that these are not normative is a good idea.
A separate section might be a nice idea, in a way that it will allow us to choose what to be generated in which circumstances. If the "Example" section is not desired for the official specification document or for any concise-formatted document, it can be omitted.
We currently (in 3.0.1) have *Example* (italic formatting, not an actual Markdown or HTML heading) in several Profiles. For example:
- model/AI/Classes/EnergyConsumption*.md
- model/Core/Datatypes/MediaType.md
- model/Security/Classes/*Relationship.md
- model/Security/Classes/Vulnerability.md
