Draft: Update Documentation

Prepare documentation for public release

Tasks

  • Complete Examples.rst
  • Complete QuickStart.rst
  • Rework README.md
  • Documentation pass for consistency
  • Review Examples
  • Decide if SetProgramOptionsCMake should be split into a separate package?
    • Keep it in and defer decision to later
    • Move it now
  • Review Copyright notices across files
  • Review CHANGELOG
  • Change package name to avoid conflicts with the O.G. Sandia SetProgramOptions
    • Options: ActiveConfigProgramOptions / ActiveConfigCommandLineOptions / SetCommandLineOptions ?
  • Review / Rework Examples
    • Are current examples good?
    • Develop progression of complexity?
    • Add examples for CMake
    • Tie in / story telling for QuickStart guide?

Documentation Refactor

Edited by William

Merge request reports

Loading