qubedmaiska
04d278b0a4
Merge remote-tracking branch 'parulin/intersphinx'
2025-09-21 13:10:09 -04:00
parulin
5fd9a6b52f
Remove garbage content introduced with intersphinx
2025-09-21 11:48:12 -04:00
parulin
12f2c7a9bd
Fix minor typo on "how-to edit the rst doc..."
...
Fix the "reStrucutredText" words. That's a good example on why it is
better not to label link when possible :)
There is other minor typos and inconsitencies (RST instead of rST).
2025-09-15 04:14:19 -04:00
parulin
f0709dd483
Fix minor typos and link on rst related pages
2025-09-13 17:35:21 -04:00
parulin
47252ef12e
Merge remote-tracking branch 'origin/main' into intersphinx
2025-09-13 17:26:08 -04:00
parulin
1a47fc973b
Add intersphinx documentation and clean syntax
...
* I replaced the `:external:` syntax by a cleaner one, as suggested by
@maiska.
* An implicit external reference is now impossible.
* Fix duplicate labels warnings
* Minor typos, including the word "orthographicallly" :)
2025-09-13 17:18:52 -04:00
qubedmaiska
d9a6e20f3a
add labeling of sections inside rst docs
2025-09-13 11:16:12 -04:00
qubedmaiska
0f77371239
add screenshots with main branch, remove obsolete images, references to main branch instead of rst for conf.py, .readthedocs.yml, attachment, _ext, use .venv
2025-09-13 09:42:04 -04:00
qubedmaiska
0bf898475f
fix references, refactor website style doc and others
2025-09-09 23:30:17 -04:00
qubedmaiska
bd26dee6a4
add info about readthedocs.yml, exchange code-block with code to be consistent
2025-09-09 12:15:52 -04:00
qubedmaiska
1be6e5f9b9
fixed linter warnings
2025-09-09 12:05:31 -04:00
qubedmaiska
e93ddb3796
fixed reference errors, minor enhancements to the docs, fix pyproject.toml, alt text to images
2025-09-09 11:39:34 -04:00
qubedmaiska
4404a5d5f5
merge upstream rst, add screenshots, rewrite how-to-edit-the-website, combine website and markdown-style-guide, enhance how-to-edit-the-rst-documentation and rst style guide, fix errors, added comments to conf.py, links to README & CONTRIBUTING
2025-09-09 05:29:19 -04:00
qubedmaiska
bb4a0b720f
merge upstream and add rst version of the how to edit Markdown and Markdown and website style guide docs
2025-09-08 02:03:08 -04:00
qubedmaiska
7172de20be
WIP, add screenshots, tips&tricks, rename old documentation
2025-09-08 01:57:27 -04:00
qubedmaiska
4d3109bfc2
Add rst files about how to edit the documentation, documentatioon and website style guide in Markdown
2025-09-08 01:24:47 -04:00
qubedmaiska
6218ea2dce
Merge remote-tracking branch 'parulin/warning-fix' into rst
2025-09-06 05:42:29 -04:00
parulin
06c6503932
Fixing various warnings from sphinx-build
...
* missing theme options in conf.py
* orphaned pages are tagged as such
* a markup mistake
* duplicate labels
* a code-block marked as python code
2025-08-18 16:52:34 -04:00
parulin
5281f045dc
Trying to fix my mistakes ...
2025-08-16 14:28:31 -04:00
qubedmaiska
367d5ca10f
Add initial How to edit the rst documentation and rst documentaion style guide docs
2025-08-15 17:26:56 -04:00
parulin
4212c5eda8
Correct code-block lexers
...
Changing `bash` lexer to `console` because it is appropriate most of
the time. Then after a manual review, some lexer have been changed.
I used `text` each time I was unsure, and for prompt outputs.
The page `/developer/building/qubes-iso-building.rst` still need to be
reviewed (look for lines starting with `$ #`).
I'm not sure about the Windows pages, should we use
[doscon](https://pygments.org/docs/lexers/#pygments.lexers.shell.MSDOSSessionLexer )
or `powershell`?
Is there an appropriate lexer for `guid.conf` content?
**Statistics - Before**
870 bash
9 python
9 c
2 yaml
**Statistics - After**
684 console
111 text
44 bash
16 yaml
9 systemd
9 c
8 python
4 ini
4 doscon
2 markdown
2 desktop
1 xorg.conf
1 xml+jinja
1 xml
1 kconfig
1 html
This suggests that the default lexer should be `console`.
2025-08-08 16:55:35 -04:00
Marek Marczykowski-Górecki
f058f77394
manual fixes
...
Manual fixes after the conversion tool. Mostly based on sphinx warnings.
2025-08-06 02:20:01 +02:00
Marek Marczykowski-Górecki
918eaa479d
Convert to RST
...
This is done using tools at
https://github.com/maiska/qubes-translation-utilz , commit
4c8e2a7f559fd37e29b51769ed1ab1c6cf92e00d.
2025-08-06 02:19:56 +02:00
Marek Marczykowski-Górecki
e14921b8a3
Rename all md files to rst
...
This is plain rename without changing content, to help git track files
history.
Do not touch files that are going to be removed during conversion.
Thanks @parulin for the idea!
2025-08-06 02:16:04 +02:00
qubedmaiska
cf30f8bab8
update
2025-04-16 10:37:02 -04:00
Marta Marczykowska-Górecka
06e37e444b
Add intro for Builder v2
2025-03-22 22:18:04 +01:00
qubedmaiska
2f094ef07d
url fixes, md link fix for rst translation
2025-02-21 04:40:39 -05:00
qubedmaiska
b9067f7b80
hyperlink fix in markdown
2025-01-22 18:15:27 -05:00
m
38cfff0ca2
preparation rst conversion
2024-07-28 12:03:07 -04:00
Dmitry V. Levin
7a15cd1a16
Fix a few typos
2024-04-26 08:00:00 +00:00
Marek Marczykowski-Górecki
c664e19fe0
gsod: update 2024 information
2024-04-05 23:02:20 +02:00
Andrew David Wong
2cf63497fa
Fill out "the project's problem" section
2024-04-02 23:42:18 -07:00
Michael Carbone
1915add853
add some text
2024-04-02 15:48:48 +02:00
Michael Carbone
558bb2a51c
include link to 2023 gsod results
2024-04-02 15:26:26 +02:00
Michael Carbone
c83e5d409c
Update gsod.md for 2024
...
still needs some content
2024-04-02 15:16:13 +02:00
Andrew David Wong
726237da0f
Merge branch 'prb/fido2' of github.com:piotrbartman/qubes-doc into piotrbartman-prb/fido2
2024-01-08 22:54:45 -08:00
Andrew David Wong
d2791f2296
Merge remote-tracking branch 'origin/main' into pr-1334
2023-12-20 10:28:06 -08:00
Marek Marczykowski-Górecki
8ad2d93e23
Change links to HTTPS
...
Change links that has HTTPS equivalent to HTTPS.
2023-12-20 12:44:21 +01:00
Andrew David Wong
56251fad41
Deduplicate heading
2023-12-14 11:24:59 -08:00
Marta Marczykowska-Górecka
474af03e9e
How to develop Qubes GUI apps doc
...
related to https://github.com/QubesOS/qubes-core-admin-client/pull/267
2023-12-11 14:37:42 +01:00
taradiddles
f6db6fc2da
Fix remaining mention of qubes-community
2023-08-15 09:37:49 +03:00
taradiddles
bd763623ca
Update qubes-community links to point to the forum
2023-08-15 09:34:37 +03:00
Piotr Bartman
a830998985
migration to fido2: update docs
2023-05-20 23:29:24 +02:00
Andrew David Wong
83c93a3c2a
Add section on English language conventions
2023-05-05 13:08:33 -07:00
Andrew David Wong
3def6f0aa6
Update line wrapping policy
...
See https://github.com/QubesOS/qubes-issues/issues/2639#issuecomment-1536615048
2023-05-05 12:59:07 -07:00
Andrew David Wong
2857445c6d
Unwrap text
2023-05-05 12:55:34 -07:00
resulin
2ea6c5a550
Update usability-ux.md
...
www.kde.org redirects to kde.org
2023-04-26 17:00:53 +00:00
resulin
92bf06636c
Update usability-ux.md: Bump mentioned Qubes OS version and fix/update some links
...
http://learndesignprinciples.com is now defunct, replaced it with a wayback machine link: https://web.archive.org/web/20180101172357/http://learndesignprinciples.com
2023-04-26 16:33:58 +00:00
Andrew David Wong
acc710bc8c
Update GSoD 2023 project idea
2023-03-04 17:35:20 -08:00
Andrew David Wong
da7794d9be
Add section on the capitalization of "qube"
...
Related to QubesOS/qubes-issues#8057
2023-03-04 15:29:43 -08:00
