compliance-trestle icon indicating copy to clipboard operation
compliance-trestle copied to clipboard

Various website enhancements

Open butler54 opened this issue 5 months ago • 1 comments

Issue description / feature objectives

This is a bit of a list of things to do in the website for compliance trestle.

  1. Use mkdocs features to avoid having to specify the full nav: (awesome-pages, inferred structure from the directory tree). [issue created]
  2. Remove / refine the api docs (backing away from the earlier discussion) [TBD]
  3. Remove where possible html as it's harder to maintain [issue created]
  4. Look to make the website as DRY (e.g. abstracting links out etc [issue created]
  5. Introduce automated spell checking [ issue created]
  6. Minimise the website content for rendering [ ]
  7. Generate social previews for linking into linkedin / slack / teams / etc.
  8. Roll up into a single website for oscal compass [propose in the community org]
  9. Ensure all assets are in the website.
  10. 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.

butler54 avatar Aug 30 '24 01:08 butler54