More documentation improvements #1253
Merged
Conversation
This file contains 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
* Add an Introduction page * Split Common Conventions in subpages * Document various backendy things like the .portal file and the config file * Rename various pages * Add a Contributing page
This little script does two adjustments to the doc files: 1. Replace the titles of the files with a shorter string 2. Fix stray unreplaced strings in the RST files It's a custom approach for XDG Desktop Portal and not necessarily upstreamable.
It was 2 levels too much, which made Sphinx consider it an admonition.
This handle_token entry is not part of the *backend* API, only the frontend. Closes: flatpak#938
swick
reviewed
Dec 29, 2023
ebassi
approved these changes
Dec 29, 2023
There was a problem hiding this comment.
For reference, I've opened this MR for GLib to generate shorter titles for the D-Bus interface pages with gdbus-codegen.
As per swick's suggestions.
Thank you, very much appreciated. I'll update the Python script when this MR reaches the CI image. |
|
In the spirit of keeping things moving, I'll merge this PR. If you have further improvements, please open up new PRs. Thanks! |
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.
This is a relatively big reorganization of the documentation pages, hopefulle for the better.
This PR:
.portalfile formatportals.configfile formatOverall I'm quite happy with the end result. You can see how it looks here: https://georgesstavracas.github.io/xdg-desktop-portal/docs/index.html