This pull request adds the feature to extract the RFC2119 defined standards from the API Standards body text, into a format that can be accessed programmatically, and in a human readable format in a single place.
Documentation around the usage of this component has been added to the README.md. When the website build runs, the scripts/extractStandards.js script runs which collates all the standards into a JSON file. This is served by the website at /assets/api-standards.json. This file is used by the Checklist component, with future intended use by a conformance tool.
To preview these changes, a local website build must be run.
npm run build - Build the website locally
npm run serve - Serve the build website locally
The checklist may be viewed at http://localhost:3000/draft/checklist when running locally, or via the side navigation.
This pull request adds the feature to extract the RFC2119 defined standards from the API Standards body text, into a format that can be accessed programmatically, and in a human readable format in a single place.
This is achieved through the use of a re-useable React component to define a Standard.
Documentation around the usage of this component has been added to the README.md. When the website build runs, the
scripts/extractStandards.jsscript runs which collates all the standards into a JSON file. This is served by the website at/assets/api-standards.json. This file is used by the Checklist component, with future intended use by a conformance tool.To preview these changes, a local website build must be run.
npm run build- Build the website locallynpm run serve- Serve the build website locallyThe checklist may be viewed at
http://localhost:3000/draft/checklistwhen running locally, or via the side navigation.Checklist page preview:
In place content preview: