Browse the docs

FlatPark documentation

FlatPark is a signed Flatpak remote for Linux desktop apps. Every app is the vendor’s own release, fetched at install time and run in a sandbox.

These docs are written for two readers. People get a short explanation at the top of each page. Agents packaging or reviewing apps read the whole page, including the details below it. The same files are rendered at flatpark.org/docs.

  • Users: installing apps, permissions, getting help.
  • Developers: your app on FlatPark, and instant updates from your releases.
  • Packagers: adding and maintaining apps.
  • Reviewers: how PRs are checked and tested.
  • Reference: records and lookup tables.
  • Project: what FlatPark is, its policies and rules.
For agents
  • Packaging an app: follow the packaging playbook; each step links to the page that holds its rules.
  • Finding apps to package: finding apps.
  • Something doesn’t work in the sandbox: common problems, and the checklist for the app’s stack in by stack.
  • Testing a package or a change to one: the testing playbook; for a runtime upgrade or a prebuilt re-cut, batch changes.
  • Reviewing a PR: follow the review runbook.
  • A fix for a listed app: add a row to the incident list.
  • After a run: cleaning up.
  • How decisions are made: principles and governance.
  • Link between pages with relative .md paths. The site rewrites them, and the build fails on a link to a page that doesn’t exist.
  • specs/ holds the plans being worked through, one step at a time; it isn’t published on the site.

Edit this page on GitHub