mirror of
https://gh.llkk.cc/https://github.com/mainwp/mainwp.dev.git
synced 2025-10-04 15:43:04 +08:00
1.1 KiB
1.1 KiB
Project Brief
Project Goals
To generate comprehensive documentation for the MainWP ecosystem using phpDocumentor 3.7.1 and automate the process with GitHub Actions.
Core Requirements
- Configure phpDocumentor to generate documentation from two source repositories.
- Create GitHub Actions workflows to automatically update documentation when source code changes.
- Deploy the generated documentation to GitHub Pages.
- Implement robust error handling and logging.
- Place generated documentation in designated subdirectories, keeping the main directory available for a custom home page and additional developer resources.
Project Scope
- Set up phpDocumentor configuration to exclude specific dependencies.
- Create GitHub Actions workflows to monitor source repositories.
- Automate pulling of latest code, documentation generation, and deployment.
- Organize documentation output in appropriate subdirectories.
- Preserve the main directory for custom index page and additional developer resources.
- Provide step-by-step instructions for implementation and maintenance.
- Document error handling and debugging strategies.