Commit Graph

6 Commits

Author SHA1 Message Date
Andrew David Wong
c29cf40910
Reorganize doc guidelines into multiple pages; update style guide
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.
2021-07-08 08:08:57 -07:00
Andrew David Wong
ffc8d71b9d
Update heading syntax; wrap text 2021-06-19 20:24:57 -07:00
Tobias Killer
9415119edc
Refactor links in order to obey the new convention rule 2021-04-11 01:00:19 +02:00
Andrew David Wong
ec11e5ab59
Fix link 2017-04-04 21:52:06 -07:00
Andrew David Wong
31a9ccd9ee
Update CONTRIBUTING.md
Direct potential contributors to read the Documentation Guidelines on
the Qubes OS website. This prevents us from having to update the
guidelines in more than one location.
2016-10-19 16:26:57 -07:00
Axon
9f28991c6e
Create CONTRIBUTING file
https://help.github.com/articles/setting-guidelines-for-repository-contributors/
2016-04-06 08:32:30 +00:00