|
1 | | -# Human Interface Guidelines |
2 | | - |
3 | | -The GNOME Human Interface Guidelines are the primary source of UX design documentation for GNOME. Live at [developer.gnome.org/hig](https://developer.gnome.org/hig). |
4 | | - |
5 | | -This version replaces the previous version which was hosted as part of the [gnome-devel-docs](https://gitlab.gnome.org/GNOME/gnome-devel-docs/) module. |
6 | | - |
7 | | -The HIG is written in [reStructuredText](https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html), generated using [Sphinx](https://www.sphinx-doc.org/en/master/index.html), and hosted using [GitLab pages](https://docs.gitlab.com/ee/user/project/pages/). It can be viewed online [here](https://developer.gnome.org/hig/). |
8 | | - |
9 | | -## Goals for the HIG |
10 | | - |
11 | | -Goals: |
12 | | - |
13 | | - - App designers and developers are the primary audiences |
14 | | - - Document the most important and commond design patterns |
15 | | - - Be easy to digest: don't be too long or verbose |
16 | | - - Use examples and demos as much as possible |
17 | | - |
18 | | -Non-goals: |
19 | | - |
20 | | - - Not a generic guide to UX design, and shouldn't try to fill in basic design knowledge, but should be accessible to those with relatively little design expertise |
21 | | - - Don't document every design pattern or possible variation |
22 | | - - Don't be prescriptive: allow designers to make their own choices, and give them the space to be creative |
23 | | - |
24 | | -## How to build and edit |
25 | | - |
26 | | -Sphinx can be used to build and preview the static html site locally, either with the browser or VS Code. |
27 | | - |
28 | | -### 1. Install dependencies |
29 | | - |
30 | | -On Fedora, run: |
31 | | - |
32 | | -``` |
33 | | -dnf install -y python3-sphinx python3-pip |
34 | | -pip3 install --upgrade furo |
35 | | -``` |
36 | | - |
37 | | -### 2. Make changes |
38 | | - |
39 | | -VS Code is a good choice for this, as it is able to preview the source files as rendered HTML. |
40 | | - |
41 | | -### 3. Build |
42 | | - |
43 | | -Building the docs checks for errors, as well as producing local static HTML of the HIG website. |
44 | | - |
45 | | -To build, run `00localbuild.sh` from the project root. The build output can then be found in ``/build``. |
46 | | - |
47 | | -### 4. Deploy changes |
48 | | - |
49 | | -Changes to `main` branch are automatically deployed to the site using CI. |
| 1 | +# Granite.code Docs |
50 | 2 |
|
| 3 | +FIXME |
0 commit comments