compliance-trestle
compliance-trestle copied to clipboard
Various website enhancements
Issue description / feature objectives
This is a bit of a list of things to do in the website for compliance trestle.
- Use mkdocs features to avoid having to specify the full
nav:
(awesome-pages, inferred structure from the directory tree). [issue created] - Remove / refine the api docs (backing away from the earlier discussion) [TBD]
- Remove where possible
html
as it's harder to maintain [issue created] - Look to make the website as
DRY
(e.g. abstracting links out etc [issue created] - Introduce automated spell checking [ issue created]
- Minimise the website content for rendering [ ]
- Generate social previews for linking into linkedin / slack / teams / etc.
- Roll up into a single website for oscal compass [propose in the community org]
- Ensure all assets are in the website.
- Make the website index leverage the repo README.md explicitly.
Caveats / Assumptions
All of these need to be broken down. Some are quite a bit of effort.
Completion Criteria
- [ ] #1698
- [ ] #1699
- [ ] #1700
- [ ] #1701
- [ ] #1702
- [ ] #1703
Decisions are made (and issues opened) on the items above.