{"id":14128398,"url":"https://github.com/flatpak/flatpak-docs","last_synced_at":"2026-01-26T13:06:51.720Z","repository":{"id":15720269,"uuid":"78654732","full_name":"flatpak/flatpak-docs","owner":"flatpak","description":"Flatpak documentation","archived":false,"fork":false,"pushed_at":"2026-01-14T10:23:40.000Z","size":3724,"stargazers_count":85,"open_issues_count":16,"forks_count":153,"subscribers_count":11,"default_branch":"master","last_synced_at":"2026-01-14T14:26:24.989Z","etag":null,"topics":["flatpak"],"latest_commit_sha":null,"homepage":"https://docs.flatpak.org","language":"reStructuredText","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/flatpak.png","metadata":{"files":{"readme":"README.rst","changelog":null,"contributing":null,"funding":null,"license":"COPYING","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,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2017-01-11T15:58:50.000Z","updated_at":"2026-01-14T10:23:45.000Z","dependencies_parsed_at":"2023-12-20T07:29:58.066Z","dependency_job_id":"e5cf6642-682a-46f8-9a24-a557bb3a3c89","html_url":"https://github.com/flatpak/flatpak-docs","commit_stats":{"total_commits":479,"total_committers":89,"mean_commits":5.382022471910112,"dds":0.8183716075156576,"last_synced_commit":"b01cc79b61ca162afec4e756fb5d7d6544017760"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/flatpak/flatpak-docs","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/flatpak%2Fflatpak-docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/flatpak%2Fflatpak-docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/flatpak%2Fflatpak-docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/flatpak%2Fflatpak-docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/flatpak","download_url":"https://codeload.github.com/flatpak/flatpak-docs/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/flatpak%2Fflatpak-docs/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28778801,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-26T11:46:04.308Z","status":"ssl_error","status_checked_at":"2026-01-26T11:46:02.664Z","response_time":59,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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":["flatpak"],"created_at":"2024-08-15T16:01:40.489Z","updated_at":"2026-01-26T13:06:51.701Z","avatar_url":"https://github.com/flatpak.png","language":"reStructuredText","funding_links":[],"categories":["Others"],"sub_categories":[],"readme":"flatpak-docs\n============\n\nThis repository is the main source of developer documentation for Flatpak. It\ncan be read at `docs.flatpak.org \u003chttp://docs.flatpak.org/\u003e`_.\n\nSome documentation is also available on the Flatpak wiki and as part of the\n``flatpak`` and ``flatpak-builder`` man pages.\n\nThe docs are written in `reStructuredText\n\u003chttp://www.sphinx-doc.org/rest.html\u003e`_ and contributions are welcome!\n\nSetup Development\n-----------------\n\nCreate a Python `virtual environment \u003chttps://docs.python.org/3/tutorial/venv.html#creating-virtual-environments\u003e`_::\n\n  python3 -m venv .venv \u0026\u0026 source .venv/bin/activate\n\nThen install the dependencies with **pip**::\n\n  pip install -r requirements.txt\n\nBuild the Documentation\n-----------------------\n\nAfter setup, you can build the documentation::\n\n  make -C docs html\n\nRun the tests::\n\n  make -C docs linkcheck\n\nYou can run an HTTP server and follow the printed link\n(`localhost:8000 \u003chttp://localhost:8000\u003e`_)\nto view the documentation in your browser::\n\n  python3 -m http.server -d docs/_build/html\n\nBuild Translations\n------------------\n\nBy default, the document being built is in English. If you want to build\ndocuments in other languages, such as Chinese, you can use the following\ncommand::\n\n  make -C docs html SPHINXOPTS='-D language=zh_CN'\n\nTranslate the Documentation\n---------------------------\n\nYou can open a pull request adding a new language.\n\nMaintainers can generate the template files (``.pot``), update the translation\nfiles (``.po``) and remove obsolete translation files (i.e. a matching ``.pot``\nfile no longer exists) by running::\n\n  make -C docs update-po\n\nAudience\n--------\n\nDesktop application developers are the primary audience for the Flatpak\ndocs, particularly the authors of existing applications, including those\nfrom non-Linux platforms.\n\nThe docs should reflect popular practice amongst this audience wherever\npossible and not assume that applications are coming from the Linux desktop\nspace. In practical terms, this means that we should expect:\n\n- Git for version control\n- GitHub for hosting\n- Freedesktop runtimes\n- No prior knowledge of Linux desktop conventions, such as ``.desktop``\n  files, AppStream and D-Bus\n\nOutside of these basic defaults, special separate attention should be paid\nto popular cross-platform technologies such as Electron and Qt.\n\nGuidelines\n----------\n\nGuidelines for those who want to contribute to the docs:\n\n- Explain basic Flatpak concepts\n- Focus on standard application developer workflows\n- Use the docs to explain the benefits of Flatpak and why a developer might\n  use it\n- Only cover what's essential for application developers - don't include\n  details of Flatpak internals unless absolutely necessary\n- Provide a developer experience that's as smooth and frictionless as possible\n- Help to prevent difficulties by anticipating potential issues developers\n  might hit, and steering them clear of them\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fflatpak%2Fflatpak-docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fflatpak%2Fflatpak-docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fflatpak%2Fflatpak-docs/lists"}