Update documentation for the global workflow

[Copilot]

This PR comprehensively updates the global workflow documentation to address outdated information, improve organization, and enhance developer guidance. The documentation now builds cleanly with significantly fewer warnings and provides clearer paths for both operational users and developers.

Key Improvements

Build Quality (94% improvement in warnings)

• Reduced Sphinx build warnings from 32 to just 2
• Fixed all critical formatting errors in reStructuredText files
• Corrected code-block syntax and table formatting issues
• Fixed title hierarchy inconsistencies throughout documentation

Directory Structure Updates

• Corrected outdated paths from workflow/ to dev/workflow/ throughout documentation
• Updated script references to match current repository structure
• Fixed references to moved utility scripts and setup files

Enhanced User vs Developer Workflows

• Reorganized main documentation flow to prioritize user setup before developer content
• Added clear separation between operational user workflows and developer testing workflows
• Enhanced setup.rst with dedicated sections for each audience

New Developer Documentation

• Added comprehensive documentation for create_experiment.py script with usage examples
• Expanded generate_workflows.sh documentation with detailed options and examples
• Included YAML configuration format documentation and test case structure
• Added environment setup requirements and CI/CD integration guidance

Content Organization

• Reordered table of contents to flow from user setup to advanced developer topics
• Added TODO notes identifying areas needing additional developer input
• Improved cross-references between related documentation sections
• Enhanced code examples with proper syntax highlighting

The documentation now provides a much clearer path for both operational users setting up experiments on tier 1 platforms and developers running tests and contributing to the codebase.


Fixes #36.

---

✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.