{"id":26480704,"url":"https://github.com/mainwp/mainwp.dev","last_synced_at":"2025-10-08T22:03:23.079Z","repository":{"id":282255333,"uuid":"947968042","full_name":"mainwp/mainwp.dev","owner":"mainwp","description":"MainWP.dev is a dedicated platform for developers working with MainWP, offering documentation, code snippets, and technical resources to extend and customize MainWP. ","archived":false,"fork":false,"pushed_at":"2025-03-13T15:10:58.000Z","size":18,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-03-13T16:22:57.828Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/mainwp.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2025-03-13T14:33:08.000Z","updated_at":"2025-03-13T15:11:02.000Z","dependencies_parsed_at":"2025-03-13T16:23:07.602Z","dependency_job_id":"2ad4b4d7-0b26-4984-8e4f-eafd08462bd6","html_url":"https://github.com/mainwp/mainwp.dev","commit_stats":null,"previous_names":["mainwp/mainwp.dev"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mainwp%2Fmainwp.dev","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mainwp%2Fmainwp.dev/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mainwp%2Fmainwp.dev/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mainwp%2Fmainwp.dev/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mainwp","download_url":"https://codeload.github.com/mainwp/mainwp.dev/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244541806,"owners_count":20469240,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-03-20T02:45:33.995Z","updated_at":"2025-10-08T22:03:23.067Z","avatar_url":"https://github.com/mainwp.png","language":null,"funding_links":[],"categories":[],"sub_categories":[],"readme":"# MainWP.dev\n\nMainWP.dev is a dedicated platform for developers working with MainWP, offering documentation, code snippets, and technical resources to extend and customize MainWP.\n\n## Project Structure\n\n- `source-code/dashboard/` - Generated API documentation for MainWP Dashboard\n- `source-code/child/` - Generated API documentation for MainWP Child\n- `mainwp-hooks/` - Generated hooks documentation (actions and filters)\n- `phpdoc/` - phpDocumentor configuration files\n- `hooks-generator/` - Scripts for generating and categorizing hooks documentation\n- `sources/` - Source repositories for documentation generation\n- `.github/workflows/` - GitHub Actions workflows for automation\n\n## Setup Instructions\n\n### Prerequisites\n\n- PHP 7.4 or higher\n- Composer\n- Git\n\n### Installation\n\n1. Clone this repository:\n   ```\n   git clone https://github.com/mainwp/mainwp.dev.git\n   cd mainwp.dev\n   ```\n\n2. Install dependencies:\n   ```\n   composer install\n   ```\n\n3. Clone the MainWP repositories into the sources directory:\n   ```\n   git clone https://github.com/mainwp/mainwp-dashboard.git sources/mainwp-dashboard\n   git clone https://github.com/mainwp/mainwp-child.git sources/mainwp-child\n   ```\n\n### Generating Documentation\n\n#### API Documentation\n\nTo generate API documentation for the MainWP Dashboard:\n\n```\nvendor/bin/phpdoc -c phpdoc/dashboard.xml\n```\n\nTo generate API documentation for the MainWP Child:\n\n```\nvendor/bin/phpdoc -c phpdoc/child.xml\n```\n\nOr use the provided script to generate both:\n\n```\n./generate-docs.sh\n```\n\n#### Hooks Documentation\n\nTo generate hooks documentation:\n\n1. Install dependencies in the hooks-generator directory:\n   ```\n   cd hooks-generator\n   composer install\n   ```\n\n2. Run the hooks generation script:\n   ```\n   ./generate-hooks.sh\n   ```\n\n3. To generate categorized hooks documentation:\n   ```\n   ./generate-categorized-hooks.sh\n   ```\n\n#### Automated Documentation Generation\n\nThe documentation is automatically generated and deployed using GitHub Actions:\n\n1. On a weekly schedule (Sunday at midnight UTC)\n2. When a new version tag is pushed\n3. When manually triggered via the GitHub Actions workflow\n4. When changes are detected in the source repositories (via webhook)\n\n## Directory Structure\n\nThe documentation is organized as follows:\n\n- `source-code/dashboard/` - API documentation for MainWP Dashboard\n- `source-code/child/` - API documentation for MainWP Child\n- Future directories will include:\n  - `rest-api/` - REST API documentation\n  - `mainwp-hooks/` - Documentation for MainWP hooks (actions \u0026 filters)\n  - `guides/` - Developer guides and tutorials\n\n## Contributing\n\nContributions to improve the documentation are welcome. Please submit pull requests to the appropriate repository.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmainwp%2Fmainwp.dev","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmainwp%2Fmainwp.dev","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmainwp%2Fmainwp.dev/lists"}