{"id":26487214,"url":"https://github.com/poppy-project/poppy-docs","last_synced_at":"2025-09-09T15:45:24.641Z","repository":{"id":48369083,"uuid":"41861602","full_name":"poppy-project/poppy-docs","owner":"poppy-project","description":"Documentation of the whole poppy platform","archived":false,"fork":false,"pushed_at":"2022-12-19T23:56:28.000Z","size":116750,"stargazers_count":31,"open_issues_count":5,"forks_count":33,"subscribers_count":24,"default_branch":"master","last_synced_at":"2024-03-26T14:29:22.459Z","etag":null,"topics":["documentation-website","gitbook","poppy"],"latest_commit_sha":null,"homepage":"http://docs.poppy-project.org","language":"CSS","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/poppy-project.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"contributing/img/edit.png","funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2015-09-03T13:35:54.000Z","updated_at":"2023-11-01T11:24:22.000Z","dependencies_parsed_at":"2023-01-29T23:16:04.416Z","dependency_job_id":null,"html_url":"https://github.com/poppy-project/poppy-docs","commit_stats":null,"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/poppy-project%2Fpoppy-docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/poppy-project%2Fpoppy-docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/poppy-project%2Fpoppy-docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/poppy-project%2Fpoppy-docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/poppy-project","download_url":"https://codeload.github.com/poppy-project/poppy-docs/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244566979,"owners_count":20473451,"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-website","gitbook","poppy"],"created_at":"2025-03-20T06:35:16.842Z","updated_at":"2025-03-20T06:35:17.369Z","avatar_url":"https://github.com/poppy-project.png","language":"CSS","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Poppy documentation\n\nThis is the source code repository for the documentation of the [Poppy Project](http://poppy-project.org). The documentation is visible on [docs.poppy-project.org](https://poppy-project.gitbooks.io/poppy-docs/content/en/) so if you want to read it, please go there. If you want to contribute please do go further with this file.\n\nDocumentation is also available to download as [PDF](https://www.gitbook.com/download/pdf/book/poppy-project/poppy-docs).\n\n## Where to start\n\nThere are some of places where you can find something to contribute to:\n\n* The issues in the [issue tracker](https://github.com/poppy-project/poppy-docs/issues).\n* The [TODO links or comments](https://github.com/poppy-project/poppy-docs/search?utf8=%E2%9C%93\u0026q=TODO) in the markdown files.\n\n## Editing basics\n\nThe source code of the documentation is [hosted on GitHub](http://github.com/poppy-project/poppy-docs). The GitHub [Fork \u0026 Pull workflow](https://help.github.com/articles/using-pull-requests) is used to accept and review changes.\n\nThe documentation is written in the [Markdown markup language](https://help.github.com/articles/markdown-basics) and uses the [GitBook](https://www.gitbook.com/book/poppy-project/poppy-docs/details) service for publishing the rendered website. [See more information about how GitBook works](http://help.gitbook.com/).\n\nYou can find discussions about the contents of the documentation on the [issue tracker](https://github.com/poppy-project/poppy-docs/issues).\n\n## Getting started and prerequisites\n\nContributing to the documentation requires the following:\n\n* A [GitHub account](https://github.com).\n* In the case of complex edits familiarity with [Git command line basics](https://help.github.com/articles/set-up-git) or familiarity with an application ([Windows](https://windows.github.com/), [Mac](https://mac.github.com/)) to push your edits made on your computer to GitHub.\n\n## Fork the repository\n\nFirst fork the [poppy-project/poppy-docs](https://github.com/poppy-project/poppy-docs) repository to your personal GitHub account:\n\n![Fork button](contributing/img/fork.png)\n\n## Editing chapter content\n\n### Simple changes\n\nFor simple changes like typo corrections you can use the GitHub online editor:\n\n1. Open your local fork page on GitHub,\n1. Go to *README.md* file in any chapter,\n1. Press the *Edit* icon (pen).\n\nand you can edit the chapter directly on github.com.\n\n![Edit button](contributing/img/edit.png)\n\nMarkdown syntax is used to edit the individual pages of the documentation.\n\n![GitHub editor](contributing/img/github_editor.png)\n\nClick on \"Commit changes\" to save your changes and create a pull request as [explained below](#making-a-pull-request).\n\n### New content and complex changes\n\nTo add new chapters, write longer snippets of text or add images, you first need to fetch a copy of the documentation on your local computer.\n\nEither use the GitHub app for your operating system (mentioned above) or `git` command line to get the repository locally. The repository address is located on your own GitHub repository fork front page:\n\n```bash\ngit clone git@github.com:yourgithubusername/poppy-docs.git\n```\n\nThen, create a branch for your new changes to sit in. Naming the branch in relation to the changes you will make can help.\n\n```bash\ngit checkout -b contributing\n```\n\nDownload the [GitBook Editor](https://www.gitbook.com/) application to your computer.\n\nThen you can open the documentation in GitBook Editor (*File* \u003e *Open book*).\n\nMake any changes in the documentation using GitBook and then save changes (*Book* \u003e *Save all*).\n\u003c!-- TODO push or not--\u003e\n\nIf you don't want to download the GitBook Editor app you can also go to the [GitBook website](http://gitbook.com), sign up for free with your GitHub account, then work directly in your browser.\n\n## Making a pull request\n\nAfter you are done editing, you have to create [a pull request](https://help.github.com/articles/using-pull-requests)  on GitHub. PoppyGirls will get notified about the pull request, review your changes, suggest any corrections if needed and then *pull* your changes to the master version.\n\nIn your own repository on GitHub press do *Compare \u0026 pull request*\n\n![PR](contributing/img/pull_request.png)\n\nFill in the information *why* this change is being made. The reviewer can see the details of the actual change, so you don't need repeat the content of the change.\n\nThen press *Create pull request*.\n\nGitHub emails will notify you for the follow up process.\n\n# Building the documentation (advanced users)\n\nIf you want to build the HTML version on your computer, without installing the desktop application of the [GitBook Editor](https://www.gitbook.com/), you can also build the book with a command line tool.\n\nYou have to install npm and [calibre](https://calibre-ebook.com/download) (the way depends on your OS).\n\n```bash\ngit clone https://github.com/poppy-project/poppy-docs.git\ncd poppy-docs/\n\nnpm install gitbook-cli -g\ngitbook install\ngitbook build ./\ngitbook pdf ./\n```\n\n# Further information and help\n\nGitHub has an excellent [documentation](https://help.github.com/). Check it out if you need help!\nFor further questions feel free to post thread in the [Poppy Project forum](https://forum.poppy-project.org).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpoppy-project%2Fpoppy-docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpoppy-project%2Fpoppy-docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpoppy-project%2Fpoppy-docs/lists"}