From d4f588014c83c0d205b5de7e2a8a33eabc157dec Mon Sep 17 00:00:00 2001 From: Eric Bouchut Date: Mon, 18 Mar 2024 18:26:45 +0100 Subject: [PATCH 1/2] =?UTF-8?q?=E2=9C=8F=EF=B8=8F=20=20Fix=20broken=20link?= =?UTF-8?q?s=20in=20README?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 24 ++++++++++++------------ 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index e88012a93f2..7f706dbbd65 100644 --- a/README.md +++ b/README.md @@ -17,7 +17,7 @@ This repository contains the source files for [Loop's](https://github.com/LoopKi - [Usage](https://loopkit.github.io/loopdocs/operation/loop/open-loop/) - [Troubleshooting](https://loopkit.github.io/loopdocs/troubleshooting/overview/) - Remote monitoring and commands with [*Nightscout*](https://loopkit.github.io/loopdocs/nightscout/overview/) -- [FAQs](https://loopkit.github.io/loopdocs/nightscout/overview/) +- [FAQs](https://loopkit.github.io/loopdocs/faqs/overview-faqs/) ## Contributing @@ -494,17 +494,17 @@ TLDR; An admonition is a colored box with a specific icon (and a title) at the Now using the standard set of [admonitions](https://squidfunk.github.io/mkdocs-material/reference/admonitions/) and CSS styles that come with the Material theme. The following are the admonition **types** we use: -- [`info`](https://squidfunk.github.io/mkdocs-material/reference/admonitions/#type:info) (blue info icon) -- [`note`](https://squidfunk.github.io/mkdocs-material/reference/admonitions/#type:note) (blue pencil icon) -- [`abstract`](https://squidfunk.github.io/mkdocs-material/reference/admonitions/#type:abstract) (blue notepad icon) -- [`tip`](https://squidfunk.github.io/mkdocs-material/reference/admonitions/#type:tip) (green flame) -- [`success`](https://squidfunk.github.io/mkdocs-material/reference/admonitions/#type:success) (a green check mark) -- [`question`](https://squidfunk.github.io/mkdocs-material/reference/admonitions/#type:question) (green question mark) -- [`warning`](https://squidfunk.github.io/mkdocs-material/reference/admonitions/#type:warning) (warning triangle) -- [`danger`](https://squidfunk.github.io/mkdocs-material/reference/admonitions/#type:danger) (red zag icon) -- [`bug`](https://squidfunk.github.io/mkdocs-material/reference/admonitions/#type:danger) (red bug icon) -- [`example`](https://squidfunk.github.io/mkdocs-material/reference/admonitions/#type:example) (a violet vial icon) -- [`quote`](https://squidfunk.github.io/mkdocs-material/reference/admonitions/#type:quote) (a gray end quote icon) +- [`info`](https://squidfunk.github.io/mkdocs-material/reference/admonitions/#+type:info) (blue info icon) +- [`note`](https://squidfunk.github.io/mkdocs-material/reference/admonitions/#+type:note) (blue pencil icon) +- [`abstract`](https://squidfunk.github.io/mkdocs-material/reference/admonitions/#+type:abstract) (blue notepad icon) +- [`tip`](https://squidfunk.github.io/mkdocs-material/reference/admonitions/#+type:tip) (green flame) +- [`success`](https://squidfunk.github.io/mkdocs-material/reference/admonitions/#+type:success) (a green check mark) +- [`question`](https://squidfunk.github.io/mkdocs-material/reference/admonitions/#+type:question) (green question mark) +- [`warning`](https://squidfunk.github.io/mkdocs-material/reference/admonitions/#+type:warning) (warning triangle) +- [`danger`](https://squidfunk.github.io/mkdocs-material/reference/admonitions/#+type:danger) (red zag icon) +- [`bug`](https://squidfunk.github.io/mkdocs-material/reference/admonitions/#+type:bug) (red bug icon) +- [`example`](https://squidfunk.github.io/mkdocs-material/reference/admonitions/#+type:example) (a violet vial icon) +- [`quote`](https://squidfunk.github.io/mkdocs-material/reference/admonitions/#+type:quote) (a gray end quote icon) - `important` (red exclamation sign) 👁️ Look at [this page](https://squidfunk.github.io/mkdocs-material/reference/admonitions/#supported-types) to see what each type of admonition looks like when rendered. From ae038ac95a5ac8fd1a9849c686033e07ef622cfc Mon Sep 17 00:00:00 2001 From: Eric Bouchut Date: Mon, 18 Mar 2024 18:27:16 +0100 Subject: [PATCH 2/2] =?UTF-8?q?=E2=9C=8F=EF=B8=8F=20Fix=20typo=20in=20READ?= =?UTF-8?q?ME?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 7f706dbbd65..e6f55478f49 100644 --- a/README.md +++ b/README.md @@ -507,7 +507,7 @@ The following are the admonition **types** we use: - [`quote`](https://squidfunk.github.io/mkdocs-material/reference/admonitions/#+type:quote) (a gray end quote icon) - `important` (red exclamation sign) -👁️ Look at [this page](https://squidfunk.github.io/mkdocs-material/reference/admonitions/#supported-types) to see what each type of admonition looks like when rendered. +👁️ To see what each type of admonition looks like when rendered, take a look at [this page](https://squidfunk.github.io/mkdocs-material/reference/admonitions/#supported-types). #### Admonition Syntax @@ -614,7 +614,7 @@ flowchart LR - Edit the text version of the glossary [`includes/tooltip-list.txt`](https://github.com/LoopKit/loopdocs/blob/main/includes/tooltip-list.txt) to **add/update/remove glossary entries** - **Create** the Markdown version of the glossary (`docs/faqs/glossary.md`). - We have handy script that does this for you: + This handy script does this for you: ``` # Transform Glossary from text to Markdown ./make-glossary.sh