wehub-resource-sync
8a21a212f8
Deploy Documentation / deploy (push) Has been cancelled
Canary / build-cli (push) Has been skipped
Canary / Upload Install Script (push) Has been skipped
Canary / bundle-desktop (push) Has been skipped
Canary / bundle-desktop-intel (push) Has been skipped
Canary / bundle-desktop-linux (push) Has been skipped
Canary / bundle-desktop-windows (push) Has been skipped
Canary / bundle-desktop-windows-cuda (push) Has been skipped
Canary / Release (push) Has been skipped
Cargo Deny / deny (push) Has been skipped
Unused Dependencies / machete (push) Has been skipped
Canary / Prepare Version (push) Failing after 1s
Live Provider Tests / check-fork (push) Failing after 0s
Create Minor Release PR / check-version-bump-pr (push) Has been skipped
Publish Ask AI Bot Docker Image / docker (push) Failing after 1s
Live Provider Tests / changes (push) Has been skipped
Scorecard supply-chain security / Scorecard analysis (push) Has been skipped
Publish Docker Image / docker (push) Failing after 1s
CI / changes (push) Failing after 8s
Create Minor Release PR / release (push) Has been skipped
Live Provider Tests / Smoke Tests (push) Has been cancelled
Live Provider Tests / Smoke Tests (Code Execution) (push) Has been cancelled
Live Provider Tests / Compaction Tests (push) Has been cancelled
CI / Build Rust Project on Windows (push) Has been cancelled
Live Provider Tests / Build Binary (push) Has been cancelled
CI / Lint Rust Code (push) Has been cancelled
CI / Check Generated Schemas are Up-to-Date (push) Has been cancelled
CI / Test and Lint Electron Desktop App (push) Has been cancelled
CI / Check Rust Code Format (push) Has been cancelled
CI / Build and Test Rust Project (push) Has been cancelled
CI / Check MSRV (push) Has been cancelled
Documentation Automation
This directory contains automated pipelines for keeping goose documentation synchronized with code changes.
Overview
Each automation project tracks specific types of changes and updates corresponding documentation:
| Project | Status | Tracks | Updates |
|---|---|---|---|
| cli-command-tracking | 🔮 Planned | CLI commands & options | CLI documentation |
| provider-tracking | 🔮 Planned | Supported AI providers | Provider documentation |
| extension-tracking | 🔮 Planned | Built-in extensions | Extension documentation |
Architecture
Each automation project follows a consistent pattern:
project-name/
├── README.md # Project-specific documentation
├── TESTING.md # How to test this automation
├── config/ # Configuration files
├── scripts/ # Deterministic extraction/diff scripts
└── recipes/ # AI-powered synthesis/update recipes
Design Principles
- Modular: Each project is self-contained
- Testable: Clear inputs/outputs at each stage
- Transparent: Intermediate files can be inspected
- Reusable: Common patterns across projects
Hybrid Approach
- Shell scripts: Deterministic extraction and comparison
- AI recipes: Synthesis and documentation updates
GitHub Actions Integration
Automation projects can be triggered via GitHub Actions workflows in .github/workflows/.
See individual project TESTING.md files for workflow usage.
Adding New Automations
When creating a new automation project:
- Create a subdirectory:
documentation/automation/your-project/ - Follow the standard structure (README, TESTING, config, scripts, recipes)
- Create corresponding GitHub Actions workflow (if needed)
- Update this README with the new project
Questions?
For project-specific questions, see the README in each project directory.