Add docs describing how to update Mir's supported protocols on Wayland Explorer#4783
Open
Add docs describing how to update Mir's supported protocols on Wayland Explorer#4783
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Adds contributor documentation for updating Mir’s supported protocol listing on Wayland Explorer by generating and submitting an updated mir.json.
Changes:
- Added a new how-to guide describing the wlprobe + miral-app workflow to regenerate
mir.json - Linked the new guide from the contributing how-to index
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 11 comments.
| File | Description |
|---|---|
| doc/sphinx/contributing/how-to/index.md | Adds entry for the new Wayland Explorer update guide |
| doc/sphinx/contributing/how-to/how-to-update-wayland-explorer.md | New step-by-step instructions for generating and updating mir.json in Wayland Explorer |
| - [](howto-contribute) | ||
| - [](how-to-update-symbols-maps) | ||
| - [Enabling graphics on a device](how-to-enable-graphics-for-snaps-on-a-device) | ||
| - [](how-to-update-wayland-explorer) |
| 1. Next, clone Wayland Explorer: | ||
|
|
||
| ```sh | ||
| git clone git@github.com:vially/wayland-explorer.git |
| ```sh | ||
| git clone git@github.com:PolyMeilex/wlprobe.git | ||
| cargo install --path wlprobe | ||
| ``` |
Comment on lines
+20
to
+32
| git clone git@github.com:vially/wayland-explorer.git | ||
| ``` | ||
|
|
||
| 1. Next, run `miral-app` with all available Wayland extensions enbled: | ||
|
|
||
| ```sh | ||
| WAYLAND_DISPLAY=wayland-98 miral-app --add-wayland-extension=all | ||
| ``` | ||
|
|
||
| 1. Then, run `wlprobe` from the `wayland-explorer` directory: | ||
|
|
||
| ```sh | ||
| cd wayland-explorer |
Comment on lines
+20
to
+32
| git clone git@github.com:vially/wayland-explorer.git | ||
| ``` | ||
|
|
||
| 1. Next, run `miral-app` with all available Wayland extensions enbled: | ||
|
|
||
| ```sh | ||
| WAYLAND_DISPLAY=wayland-98 miral-app --add-wayland-extension=all | ||
| ``` | ||
|
|
||
| 1. Then, run `wlprobe` from the `wayland-explorer` directory: | ||
|
|
||
| ```sh | ||
| cd wayland-explorer |
Comment on lines
+11
to
+17
|
|
||
| ```sh | ||
| git clone git@github.com:PolyMeilex/wlprobe.git | ||
| cargo install --path wlprobe | ||
| ``` | ||
|
|
||
| 1. Next, clone Wayland Explorer: |
Comment on lines
+11
to
+17
|
|
||
| ```sh | ||
| git clone git@github.com:PolyMeilex/wlprobe.git | ||
| cargo install --path wlprobe | ||
| ``` | ||
|
|
||
| 1. Next, clone Wayland Explorer: |
Comment on lines
+22
to
+29
|
|
||
| 1. Next, run `miral-app` with all available Wayland extensions enbled: | ||
|
|
||
| ```sh | ||
| WAYLAND_DISPLAY=wayland-98 miral-app --add-wayland-extension=all | ||
| ``` | ||
|
|
||
| 1. Then, run `wlprobe` from the `wayland-explorer` directory: |
Comment on lines
+22
to
+29
|
|
||
| 1. Next, run `miral-app` with all available Wayland extensions enbled: | ||
|
|
||
| ```sh | ||
| WAYLAND_DISPLAY=wayland-98 miral-app --add-wayland-extension=all | ||
| ``` | ||
|
|
||
| 1. Then, run `wlprobe` from the `wayland-explorer` directory: |
Comment on lines
+28
to
+29
|
|
||
| 1. Then, run `wlprobe` from the `wayland-explorer` directory: |
Contributor
|
@copilot convert this documentation into a GitHub Actions step in spread.yaml for the |
3 tasks
Contributor
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.
What's new?
Added documentation explaining how to update Mir's json file in Wayland Explorer
How to test
Run the steps and see that it works
Checklist