Adding template for detailed use case documentation and first use case in-detail document #117
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR proposes a way to state use cases in more detail than the summary table currently allows for while retaining the readability of the summary table by breaking detailed explanations off into their own folder.
This also proposes that each use case adhere to a markdown-style page metadata structure that is fully worked out in the extended template. This metadata structure would allow the markdown files to be parsed by a build or scanning tool that could then use them to create filters or sorting methods as requested in previous conversations in the group.
I do not yet propose the methodology for how to handle that build process, I think the first step is to assure this addresses all needs both in form, format and level of metadata included. Assume that each metadata field would be able to act as a filter or sort, depending on data-type. If this seems sufficient we can start building out further documents and approach a build or Github action hook process that can turn these into a single sort-able, expandable page or some other format.
Long term the product created out of these separate documents could, like the Dashboard, represent a product of this group and replace the single
support_for_advertising_use_cases
document.In order to help make this process clearer, I have added the first in-detail document for Viewability / IVT as an example.