Problem
Documentation is currently split over many sources:
README.mdqualops-llm.txt- example configuration
- Claude init command (
init-claude) and .claude/commands/qualops-setup.md
It's difficult to aggregate these into reference documentation for humans. They also conflict as sources of truth.
Proposed Solution
Consumers of the tool would benefit from a single source of truth of versioned documentation. GitHub Pages published from source docs within the repo would be a great way of publishing documentation. The existing EggAI framework does this already: https://github.com/eggai-tech/EggAI/tree/main/docs
Notes
The EggAI framework publishes docs to the subdomain https://docs.egg-ai.com - there needs to be some discussion around the best href for QualOps docs. It may be fine to use https://eggai-tech.github.io/qualops for now (note that the SDK docs are just a CNAME on https://eggai-tech.github.io/EggAI)
Problem
Documentation is currently split over many sources:
README.mdqualops-llm.txtinit-claude) and.claude/commands/qualops-setup.mdIt's difficult to aggregate these into reference documentation for humans. They also conflict as sources of truth.
Proposed Solution
Consumers of the tool would benefit from a single source of truth of versioned documentation. GitHub Pages published from source docs within the repo would be a great way of publishing documentation. The existing EggAI framework does this already: https://github.com/eggai-tech/EggAI/tree/main/docs
Notes
The EggAI framework publishes docs to the subdomain https://docs.egg-ai.com - there needs to be some discussion around the best href for QualOps docs. It may be fine to use https://eggai-tech.github.io/qualops for now (note that the SDK docs are just a CNAME on https://eggai-tech.github.io/EggAI)