{"id":14987201,"url":"https://github.com/codeigniter4/docs-update","last_synced_at":"2025-03-25T12:33:13.190Z","repository":{"id":213342251,"uuid":"733529887","full_name":"codeigniter4/docs-update","owner":"codeigniter4","description":null,"archived":false,"fork":false,"pushed_at":"2023-12-24T08:03:25.000Z","size":2350,"stargazers_count":2,"open_issues_count":0,"forks_count":2,"subscribers_count":8,"default_branch":"develop","last_synced_at":"2025-03-20T08:24:24.396Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/codeigniter4.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2023-12-19T14:32:36.000Z","updated_at":"2023-12-22T06:55:18.000Z","dependencies_parsed_at":"2023-12-24T09:19:41.490Z","dependency_job_id":null,"html_url":"https://github.com/codeigniter4/docs-update","commit_stats":null,"previous_names":["codeigniter4/docs-update"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codeigniter4%2Fdocs-update","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codeigniter4%2Fdocs-update/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codeigniter4%2Fdocs-update/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codeigniter4%2Fdocs-update/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/codeigniter4","download_url":"https://codeload.github.com/codeigniter4/docs-update/tar.gz/refs/heads/develop","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245463011,"owners_count":20619596,"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":"2024-09-24T14:14:14.827Z","updated_at":"2025-03-25T12:33:08.722Z","avatar_url":"https://github.com/codeigniter4.png","language":"PHP","readme":"# CodeIgniter Documentation Project\n\nThe aim of this project is to convert the CodeIgniter User Guide from the existing reStructuredText format to Markdown format,\nmaking it easier to maintain and contribute to, as well as allowing all of our projects to share a common documentation format.\n\n## The Conversion Process\n\nThe conversion process is being done using pandoc to do the initial conversion.\nFrom there, each section and file will be manually reviewed and cleaned up as needed.\n\nOnce the conversion is complete, we will start taking a look at the overall structure of the documentation and see what changes need\nto be made for consistency, clarity, and ease of understanding.\n\n## Requirements\n\nTo convert, pandoc is required. To install it, see \u003chttps://pandoc.org/installing.html\u003e.\n\n## Next Steps:\n\n- [x] Build converter script to convert all files from rst to md\n- [ ] Modify converter to insert code samples and remove unnecessary files.\n- [ ] Review and clean up converted files\n- [ ] Review and clean up overall structure of documentation\n- [ ] Standardize how pages are written to include cohesive structure and examples\n\n## Commands:\n\n### Converting all files\n\nTo convert all files from rst to md:\n\n```bash\nphp ./admin/convert.php\n```\n\n\u003e [!NOTE]\n\u003e This will first delete all files and directories in the `./docs` directory, except for the `assets` directory,\nwhich contains images and other assets used by the documentation.\n\nYou can also run conversion with [filters](./admin/how_to_use_filters):\n\n```bash\nphp ./admin/convert-with-filters.php\n```\n\n### Previewing the converted files\n\nSee the [How to Build Docs](./admin/how_to_build_docs.md) document for instructions on building and previewing the converted files.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcodeigniter4%2Fdocs-update","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcodeigniter4%2Fdocs-update","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcodeigniter4%2Fdocs-update/lists"}