AI skill for Flatpak packaging#630
Closed
besdar wants to merge 2 commits intoflatpak:masterfrom
Closed
Conversation
Author
|
The validation fails because those links don’t exist yet before the merge of this pull request. I can change the links, but I don't know how in this case. |
Collaborator
|
Not interested. I don't want a parallel set of docs just to satisfy LLMs' hunger. It's duplicated effort to maintain these .md alongside .rst. If you are a beginner and using LLMs for Flatpak packaging, I suggest to not do that and rather read the existing documentation itself. At least that way, we can improve the existing documentation for everyone. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Hello @bbhtt and the Flatpak team,
In this pull request, I am adding a
flatpak-packagingAI assistant skill and short mentions of its location inREADME.rstanddocs/tips-and-tricks.rst. The changes in your documentation only mention where the skill lives and what it is for.Why include this
More Flatpak developers (and I personally) are using AI coding assistants to draft manifests, choose runtimes, review sandbox permissions, and debug
flatpak-builderfailures. A repository-local skill gives those assistants a compact, maintainer-reviewable summary of the Flatpak packaging guidance in this repository, instead of forcing each assistant to infer packaging practice from scattered files or stale third-party examples.Keeping the skill in this repository is useful because it can evolve alongside the documentation it summarizes. When runtime recommendations, permissions, extension guidance, or packaging conventions change, maintainers can review the assistant-facing guidance in the same place as the human-facing docs.
Source documentation
The skill files are self-contained so they remain clear when installed without a local checkout of this repository. The table below records the repository documentation files that were summarized into each bundled reference file:
references/build-debug.mddocs/first-build.rst,docs/building-introduction.rst,docs/flatpak-builder.rst,docs/debugging.rst,docs/tips-and-tricks.rst,docs/using-flatpak.rstreferences/distribution-and-repositories.mddocs/publishing.rst,docs/repositories.rst,docs/hosting-a-repository.rst,docs/single-file-bundles.rst,docs/flatpak-builder.rstreferences/extensions.mddocs/dependencies.rst,docs/extension.rst,docs/available-runtimes.rst,docs/conventions.rstreferences/framework-notes.mddocs/python.rst,docs/electron.rst,docs/dotnet.rst,docs/qt.rstreferences/manifest-and-sources.mddocs/manifests.rst,docs/module-sources.rst,docs/dependencies.rst,docs/first-build.rstreferences/runtimes-and-conventions.mddocs/available-runtimes.rst,docs/basic-concepts.rst,docs/dependencies.rst,docs/conventions.rst,docs/desktop-integration.rstreferences/sandbox-permissions.mddocs/sandbox-permissions.rst,docs/portals.rst,docs/desktop-integration.rst,docs/debugging.rstWhat skills are
Skills are portable instruction folders for AI agents. A skill usually contains a
SKILL.mdfile with trigger metadata and workflow guidance, plus optional reference files, scripts, or assets. AI assistants load the skill when a user asks for a task in that domain, giving the assistant project-specific context and reducing generic or outdated answers.For background on the AI skills format and ecosystem, see:
This change in the documentation only points to the skill folder and describes its purpose. The new files only add optional metadata that AI assistants can use when helping developers package applications with Flatpak.
Thank you for considering this pull request. I am ready to answer any questions or adjust the wording/structure if there is a better fit for the Flatpak documentation repository.