mirror of
https://github.com/QubesOS/qubes-doc.git
synced 2024-10-01 01:25:40 -04:00
c29cf40910
The existing doc guidelines page attempts to combine too many different topics at once and includes information that does not pertain directly to the documentation. This reorganization is intended to make each type of information easier to find. For example, some have found it difficult to find the documentation style guidelines (see, e.g., QubesOS/qubes-issues#6701#issuecomment-875875610). This reorganization allows us to assign more specific titles to each page. General changes: - Create new page for contribution instructions - Create new page for website style guide - Create new page for continuous integration - Rename existing "style guide" to "visual style guide" in order to avoid ambiguity with new doc and website style guides - Retain existing page solely for doc style guide - Update page names and permalinks - Update existing links - Improve language Doc style guide changes: - Add section on using sentence case in headings (see QubesOS/qubes-issues#6756 and #1173) - Improve section organization - Clarify language In order to better preserve the Git history of each file, file renames will be handled in a separate commit.
12 lines
493 B
Markdown
12 lines
493 B
Markdown
# Qubes OS Documentation
|
|
|
|
Canonical URL: https://www.qubes-os.org/doc/
|
|
|
|
All [Qubes OS Project](https://github.com/QubesOS) documentation pages are
|
|
stored as plain text files in this dedicated repository. By cloning and
|
|
regularly pulling from this repo, users can maintain their own up-to-date
|
|
offline copy of all Qubes documentation rather than relying solely on the Web.
|
|
|
|
To contribute, please see [how to edit the
|
|
documentation](https://www.qubes-os.org/doc/how-to-edit-the-documentation/).
|