{"id":15145514,"url":"https://github.com/prestashop/doctoolsbundle","last_synced_at":"2025-03-25T14:31:17.110Z","repository":{"id":50874949,"uuid":"366048935","full_name":"PrestaShop/DocToolsBundle","owner":"PrestaShop","description":"Helper tools for documentation","archived":false,"fork":false,"pushed_at":"2023-07-31T16:02:00.000Z","size":89,"stargazers_count":1,"open_issues_count":1,"forks_count":4,"subscribers_count":18,"default_branch":"main","last_synced_at":"2025-03-20T09:51:15.720Z","etag":null,"topics":["documentation","prestashop"],"latest_commit_sha":null,"homepage":"","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/PrestaShop.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":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-05-10T13:17:44.000Z","updated_at":"2023-07-22T07:46:25.000Z","dependencies_parsed_at":"2024-09-21T18:10:41.007Z","dependency_job_id":null,"html_url":"https://github.com/PrestaShop/DocToolsBundle","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PrestaShop%2FDocToolsBundle","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PrestaShop%2FDocToolsBundle/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PrestaShop%2FDocToolsBundle/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PrestaShop%2FDocToolsBundle/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/PrestaShop","download_url":"https://codeload.github.com/PrestaShop/DocToolsBundle/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245480335,"owners_count":20622295,"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":["documentation","prestashop"],"created_at":"2024-09-26T11:40:27.533Z","updated_at":"2025-03-25T14:31:16.657Z","avatar_url":"https://github.com/PrestaShop.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"# DocToolsBundle\nHelper tools for documentation\n\n## Installation\n\nAs usual, there are a few steps required to install this bundle:\n\n1.a **Add this bundle to your project using composer**:\n\n```bash\n$ composer require prestashop/doc-tools-bundle\n```\n\n1.b **Add this bundle to your project as a composer dependency (from your forked repository)**:\n\n```javascript\n    // composer.json\n    {\n        // ...\n        require-dev: {\n            // ...\n            \"prestashop/doc-tools-bundle\": \"dev-my-branch\"\n        },\n        // ...\n        \"repositories\": [\n            // ...\n            {\n                \"type\": \"vcs\",\n                \"url\": \"https://github.com/myfork/DocToolsBundle\",\n                \"canonical\": false\n            },\n            // ...\n        ],\n    }\n```\n\n```bash\n$ composer require prestashop/doc-tools-bundle\n```\n\n2. **Add this bundle to your application kernel**:\n\n```php\n    // app/AppKernel.php\n    public function registerBundles()\n    {\n        $bundles = array(\n            // ...\n            new PrestaShop\\DocToolsBundle\\DocToolsBundle(),\n        );\n\n        return $bundles;\n    }\n```\n\n3. **Configure the bundle via app/config**\n\n```yml\n# app/config/config.yml\ndoc_tools:\n  docs_src_path: /root/path/to/docs/project/src\n  cqrs_folder: content/1.7/development/architecture/domain/references\n```\n\n4. **How to use**\n\nThis bundle includes a few commands that you can use to generate documentations. The PrestaShop dev documentation is\nversioned in this repository https://github.com/PrestaShop/docs, so you will have to clone it as well in order to export\nthe generated documentation.\n\n## Command list\n\n```bash\nprestashop\n  prestashop:doc-tools:list-commands-and-queries      Lists available CQRS commands and queries\n  prestashop:doc-tools:print-commands-and-queries     Prints available CQRS commands and queries to a file prepared for documentation\n```\n\n### prestashop:doc-tools:print-commands-and-queries\n\nWhen you generate CQRS commands documentation details you should export them into the `content/1.7/development/architecture/domain/references` folder of the Docs project.\n\n```bash\nphp ./bin/console prestashop:doc-tools:print-commands-and-queries --dir=/path/to/doc_project/src\n```\n\nOr if you correctly set the `docs_src_path` config you can simply run:\n\n```bash\nphp ./bin/console prestashop:doc-tools:print-commands-and-queries\n```\n\n5. **How to test**\n\nThis bundle includes automatic tests which are run automatically by GitHub actions. You can run them locally by using:\n\nUnit tests:\n```bash\ncomposer run unit-tests\n```\n\nIntegration tests:\n```bash\ncomposer run integration-tests\n```\n\nTest all:\n```bash\ncomposer run test-all\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fprestashop%2Fdoctoolsbundle","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fprestashop%2Fdoctoolsbundle","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fprestashop%2Fdoctoolsbundle/lists"}