From 5cc0f115a12cb32c724f200d1226161721bb713d Mon Sep 17 00:00:00 2001 From: Aesara Binder Date: Wed, 13 Mar 2024 16:06:12 +1030 Subject: [PATCH] Added info shortcode and documented it --- assets/icons/alert-outline.svg | 3 +++ pages/docs/backend/_index.md | 2 ++ pages/docs/contributing/_index.md | 2 ++ pages/docs/contributing/documentation.md | 1 + pages/docs/hig/_index.md | 4 ++-- pages/docs/uxui/_index.md | 2 +- themes/mypaint | 2 +- 7 files changed, 12 insertions(+), 4 deletions(-) create mode 100644 assets/icons/alert-outline.svg diff --git a/assets/icons/alert-outline.svg b/assets/icons/alert-outline.svg new file mode 100644 index 0000000..9d850ff --- /dev/null +++ b/assets/icons/alert-outline.svg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:d954aada0e80e4ed0d44387df4a2530a6c426da7501d4218f9c8db788f40203d +size 141 diff --git a/pages/docs/backend/_index.md b/pages/docs/backend/_index.md index af56479..10b5ea3 100644 --- a/pages/docs/backend/_index.md +++ b/pages/docs/backend/_index.md @@ -8,6 +8,8 @@ including files and technical concepts to help developers conceptualise MyPaint. The most detailed documentation for the project will always be contained within the source code. +{{< info type="warning" >}}This section is heavily in development{{< /info >}} + # Contributor Responsibilities - Please write code that matches what you see elsewhere. [Style guide]({{< ref "../contributing/style-guide" >}}) - [Git workflow]({{< ref "../contributing/git" >}}) diff --git a/pages/docs/contributing/_index.md b/pages/docs/contributing/_index.md index 32b3bd5..4af4b31 100644 --- a/pages/docs/contributing/_index.md +++ b/pages/docs/contributing/_index.md @@ -10,6 +10,8 @@ the MyPaint project. We abide by an agreed [code of conduct]({{< relref "code-of-conduct" >}}). Please follow them when engaging with the project, it helps us focus on what's important. +{{< info >}}This section may contain incomplete pages{{< /info >}} + # Getting Started {{< flex grow="true" >}} {{< button content="Translating MyPaint" href="translating/adding-translations" diff --git a/pages/docs/contributing/documentation.md b/pages/docs/contributing/documentation.md index dcb7292..563a76d 100644 --- a/pages/docs/contributing/documentation.md +++ b/pages/docs/contributing/documentation.md @@ -188,6 +188,7 @@ Front matter specific to [list pages][hugo-list] |``grid``|Inline|[``rows``][css-rows], [``columns``][css-columns], [``align``][css-align]|Enclose the contained content in a [grid][css-grid]| |``id``|Content|``0``: string|Enclose the contained content in a [``span``][html-span] tag with [``id="0"``][html-attr-id]| |``img``|Inline|[``alt``][html-img-alt]: string, [``src``][html-img-src]: path, ``caption``: string, [``float``][css-float], [``width``][css-max-width] |Insert an [image][html-img]| +|``info``|Content|``type``: oneof (information, warning)|Draw an infobox| |``md``|Content|None|Renders markdown in contained content (for [shortcodes without markdown][hugo-shortcode-nomd])| |``paramref``|Inline|``0``: [Site parameter][hugo-params]|Like [``ref``][hugo-ref], but with a site parameter| diff --git a/pages/docs/hig/_index.md b/pages/docs/hig/_index.md index e2cad35..4eb6487 100644 --- a/pages/docs/hig/_index.md +++ b/pages/docs/hig/_index.md @@ -5,13 +5,13 @@ title = "Human Interface Guidelines" Developing a feature that gets exposed to the user? Refer to these guidelines to implement them in a consistent fashion. -{{< colour "yellow" >}}**This section is heavily in development**{{< /colour >}} - MyPaint's [human interface guidelines](https://en.wikipedia.org/wiki/Human_interface_guidelines) sets out rules to help developers maintain consistency in the [user experience]({{< relref "../uxui" >}}). Additionally, by providing these guidelines, developers have a point of reference when justifying inconsistent design. +{{< info type="warning" >}}This section is heavily in development{{< /info >}} + # Throwaway - Excellent fullscreen workflow. GUI elements can appear only on demand and directly at the cursor. diff --git a/pages/docs/uxui/_index.md b/pages/docs/uxui/_index.md index 5255bc4..cba44d7 100644 --- a/pages/docs/uxui/_index.md +++ b/pages/docs/uxui/_index.md @@ -7,7 +7,7 @@ between specifications and the backend. It is the primary source of reference fo developers and designers when suggesting, discussing, and prototyping new user-facing features for MyPaint. -{{< colour "yellow" >}}**This section is heavily in development**{{< /colour >}} +{{< info type="warning" >}}This section is heavily in development{{< /info >}} # UX/UI Philosophy As MyPaint continues to grow and expand its feature set, the project needs to ensure diff --git a/themes/mypaint b/themes/mypaint index 487c620..ca73579 160000 --- a/themes/mypaint +++ b/themes/mypaint @@ -1 +1 @@ -Subproject commit 487c62064ad1f7329d485ae2210a4c1a25eca3fe +Subproject commit ca73579568a97ab869a2eb8d8d6913905ca9bd77