Documentation points to the wrong branch?

otter2 · December 23, 2025, 12:43am

How to edit documentation and “Edit on Github” link use rst branch of qubes-doc meanwhile everybody is sending prs to main, not rst.

I’m not 100% sure on this and I don’t really have any more time today so hopefully someone else fixes it

parulin · December 23, 2025, 5:56am

There is indeed a bug about “Edit on Github”, mentioned here:

github.com/QubesOs/qubes-issues

"Edit on GitHub" links on doc pages open source files in the `rst` branch instead of the `main` branch

opened 06:07AM - 17 Nov 25 UTC

andrewdavidwong

C: doc P: default needs diagnosis

### Qubes OS release _No response_ ### Brief summary When clicking the "Edit …on GitHub" link on a documentation page, the link opens that page's source file in the `rst` branch, but it looks like PRs are supposed to be made against the `main` branch instead, so the PR submitter must (know to) manually change the branch. ### Steps to reproduce 1. Go to a documentation page. 2. Click on the "Edit on GitHub" link in the upper-right corner. ### Expected behavior Opens the source file for that page in the `main` branch. ### Actual behavior Opens the source file for that page in the `rst` branch. ### Additional information I actually don't know which branch is the desired one, but when I went to open a PR, I saw that existing PRs from knowledgeable people were opened against `main` (not `rst`), so I did that too, and some of those PRs have been successfully merged, so I guess `main` must be the right one.

I don’t know why we haven’t fixed such a trivial issue yet!

What you mentioned about “How to edit documentation” should have been fixed:

github.com/QubesOs/qubes-issues

Documention list RST tree in some parts

opened 06:00PM - 12 Sep 25 UTC

closed 09:19AM - 15 Sep 25 UTC

ben-grande

C: doc P: default C: infrastructure diagnosed pr submitted

### Qubes OS release Qubes OS 4.2, Qubes OS 4.3 ### Brief summary https://doc….qubes-os.org/en/latest/developer/general/how-to-edit-the-rst-documentation.html#tl-dr-how-to-add-images attachment/doc -> https://github.com/QubesOS/qubes-doc/tree/rst/attachment/doc ### Steps to reproduce 1. https://doc.qubes-os.org/en/latest/developer/general/how-to-edit-the-rst-documentation.html#tl-dr-how-to-add-images 2. See attachment/doc 3. ### Expected behavior Uses the main branch. ### Actual behavior Uses a feature branch. ### Additional information _No response_

otter2 · December 23, 2025, 2:49pm

Great!

Speaking of “How to edit documentation”, the commit you have linked to doesn’t change doc-pr_09_create-pr-rst.png. It shows the process of creating a pull request, right before " Viewing your pull request on RTD" section

I might be too pedantic at this point, but as far as I can tell there is no direct instruction to submit prs against main and the only screenshot shows rst branch. This can be misleading for newcomers.

parulin · December 23, 2025, 4:25pm

I agree: those pages about editing the documentation should be as accurate as possible, because we want newcomers without previous experience of Github or RST to be able to edit the docs.

Still, after #10410 is fixed, the default branch should be main; the maintainers can change that so I consider that it is not my priority