Documentation

[swo]

PR contents

• Reduced Getting Started material in README.md to some limited examples on dataset listing & accessing
• Moved all ETL running and new dataset creation information that was in README.md to the developer guide
• Removed duplicated user guide that was at the bottom of the developer guide
• Add support for mkdocs
  • Add CI: this will automatically serve/update the docs on GitHub Pages. See https://cdcgov.github.io/reedfrost/ for an example, including the API reference.
  • Put the filenames for example files into the code block title (see below for example)

Using mkdocs

To review this PR, you'll probably want to see the rendered docs. You'll need to build those locally; they get posted as artifacts only on landing the PR.

• Install mkdocs dependencies with poetry install (they are just python packages that are in the poetry dependency group mkdocs)
• Serve locally with poetry run mkdocs serve
• Build a static local copy with poetry run mkdocs build

After landing this PR

Hopefully everything just works and the docs end up at <cdcgov.github.io/cfa-dataops>, although often I find I need to do 1-2 more commits to troubleshoot.

Open questions

• What functions or objects should be in the API documentation?
• Do you want to move any of the CLI functionality into different docs? E.g., the command line options that go with each workflow

[cdc-ap66]

These are some amazing updates!. Thank you for going through the trouble to digest and update the docs, AND for adding the mkdocs generation. I can't wait to see the docs after they generate. I'd love to grab some time to show you some new features I have been working on and to get some of your ideas for where you see this evolving into. LGTM

[cdc-ap66]

please bump the version and consider copying your change summary to the changelog.md. One thing I usually do is add my summary to the changelog and then copy it into the PR description, adding screenshots and extra color, but keeping the bulk of it unchanged. example:

• PR Ap66_adding_reporting_functionality #9
• changelog.md https://github.com/CDCgov/cfa-dataops/blob/main/changelog.md#202508010a

[swo]

Done!