From 3306c42cc6defbfc92df2b2a4a73f492acdcc5a3 Mon Sep 17 00:00:00 2001 From: James Elliott Date: Mon, 6 Mar 2023 20:17:57 +1100 Subject: [PATCH] docs: accessibility guidelines (#5033) --- .../contributing/guidelines/accessibiliy.md | 36 +++++++++++++++++++ .../en/contributing/guidelines/style.md | 2 +- 2 files changed, 37 insertions(+), 1 deletion(-) create mode 100644 docs/content/en/contributing/guidelines/accessibiliy.md diff --git a/docs/content/en/contributing/guidelines/accessibiliy.md b/docs/content/en/contributing/guidelines/accessibiliy.md new file mode 100644 index 000000000..b41d928a2 --- /dev/null +++ b/docs/content/en/contributing/guidelines/accessibiliy.md @@ -0,0 +1,36 @@ +--- +title: "Accessibility" +description: "Authelia Development Accessibility Guidelines" +lead: "This section covers the accessibility guidelines we aim to respect during development." +date: 2023-03-06T11:42:13+11:00 +draft: false +images: [] +menu: + contributing: + parent: "guidelines" +weight: 350 +toc: true +--- + +## Backend + +There are no specific guidelines for backend accessibility other than ensuring there are reasonable logging and this is +extremely subjective. + + +## Frontend + +### Translations + +We aim to ensure as much of the web frontend information displayed to users is translated by default. This allows for +both automatic and manual translations by the community to be contributed to the code base. In addition it allows for +admins to locally override these values. + +### Responsive Design + +We aim to make the web frontend responsive to multiple screen resolutions. There are a few guidelines which we aim to +abide by: + +- The available space is utilized efficiently in order to avoid scrolling where possible. +- The user only has to scroll in one direction to view available information. This direction should always be + vertically. diff --git a/docs/content/en/contributing/guidelines/style.md b/docs/content/en/contributing/guidelines/style.md index 9d559985b..e99e5bb8f 100644 --- a/docs/content/en/contributing/guidelines/style.md +++ b/docs/content/en/contributing/guidelines/style.md @@ -8,7 +8,7 @@ images: [] menu: contributing: parent: "guidelines" -weight: 320 +weight: 350 toc: true aliases: - /docs/contributing/style-guide.html