docs: ✨ add landing page #79
Conversation
github-project-automation
bot
moved this from In Review
to In Progress
in Iteration planning
Co-authored-by: Luke W. Johnston <lwjohnst86@users.noreply.github.com>
| - Provides clear and user-friendly messages that point directly to | ||
| where issues occur in the descriptor. | ||
| - Supports a strict mode that enforces full compliance with the | ||
| standard, including all recommended fields. |
There was a problem hiding this comment.
| standard, including all recommended fields. | |
| standard, including all recommended rules. |
Or "checks"? Because we're not talking about the fields but constraints on those fields
There was a problem hiding this comment.
| standard, including all recommended fields. | |
| standard, including all recommended values. |
Values maybe? or property values?
There was a problem hiding this comment.
I think "checks" might be better here. The recommendations are for the existence of properties. (ones with SHOULD or MAY language in the standard).
There was a problem hiding this comment.
I just looked into it and, as far as I understand now, the recommendations are actually both for the existence of properties (e.g., "A Data Package descriptor [...] SHOULD have name, id, licenses, and profile properties.") and for the values of those properties (e.g., "It [the name] SHOULD be human-readable and consist only of lowercase English alphanumeric characters plus ., - and _.") (both quotes are from the description of the Data Package.
So, it depends on what the strict mode actually does: Does it both check for the existence of the recommended properties and for the values of those properties?
I don't like "check" bc it feels unspecific. Could an alternative be (if strict mode does both things described above):
| standard, including all recommended fields. | |
| standard, including checking the existence of all recommended properties and their recommended values. |
?
There was a problem hiding this comment.
Could also just be:
| standard, including all recommended fields. | |
| standard, including all recommendations. |
Suggestion by @martonvago Co-authored-by: martonvago <57952344+martonvago@users.noreply.github.com>
Description
This adds a landing page to the website. This is a first draft and I'm a bit out of touch with this package, so let me know if something's off :)
Closes #8
Needs an in-depth review.
Checklist
just run-all