Documentation Sitemap proposal

This page is for brainstorming ways to improve the state of Flatpak and Flathub documentation to improve the developer experience.

• Home
  • About Flatpak
    • OSTree snapshot vs. file bundle
    • Compared to Snap and AppImage
• Get Started
  • Quick start guide
    • Install flatpak
    • add remote, install runtime & sample app
  • Your first flatpak
    • Init, build, bundle, install & run “hello world” in < 5 minutes
• Building
  • Runtimes & SDKs
    • SDK environment vs. host environment
  • Flatpak- builder
    • Creating a new manifest.json
      • build-options
      • finish-args
      • modules
        • buildsystem
        • sources
        • cleanup
    • Building modules from source
      • Build Systems
        • autotools
        • cmake
        • cmake-ninja
        • meson
        • simple
    • Tutorials
      • Make
      • Autotools
      • CMake
      • QMake
      • Meson
      • Python
      • Electron
      • Vala
      • Java
  • Export files
  • Testing your flatpak
    • Local repo (build- export)
    • Per- user app installation
    • Debugging your Flatpak
      • Getting a shell in your app’s sandbox
      • Debugging tools in the SDK
      • Creating a .Debug extension
      • Overriding permissions
  • Adding extensions
  • Localization
• Publishing
  • Creating a .flatpak file
  • Flatpak repositories
    • .flatpakrepo
  • Hosting your own
    • .flatpakref
  • Using Flathub
• Reference
  • Flatpak command- line arguments
  • Flatpak build vs flatpak- builder
  • Flatpak build
    • Creating a flatpak directory (build- init)
    • Building from sources (build)
    • Granting permissions (build- finish)
    • About the metadata file
  • Metadata file format
  • Manifest file format
  • Sandbox Permissions
  • .flatpak bundle file format
  • .flatpakrepo file format
  • .flatpakref file format