awslabs / awslabs/aws-encryption-sdk-specification
move spec doc versions into yaml metadata
Open
- Dominant language
- JavaScript
- Stars
- 37
- Forks
- 27
- PR merge metrics
- No merged PRs in 30d
Description
We should move the version statement to YAML metadata in spec documents to give us a path to machine-interaction with the version.
https://github.blog/2013-09-27-viewing-yaml-metadata-in-your-documents/
Contributor guide
Research direction
Start by locating the specification documents and their current version statements. Review the linked YAML metadata guidance, move the version information into metadata, and verify that the documents expose the version for machine interaction.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- yaml
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100