From 7ca321398fc7b258618c5b71fb2daf9174407a83 Mon Sep 17 00:00:00 2001 From: Rob Redpath Date: Fri, 10 Jan 2025 17:03:28 +0000 Subject: [PATCH] Linting --- src/scss/components/footer/Docs.mdx | 6 +++--- src/scss/components/header/Docs.mdx | 12 ++++++------ src/usage.mdx | 4 ++-- 3 files changed, 11 insertions(+), 11 deletions(-) diff --git a/src/scss/components/footer/Docs.mdx b/src/scss/components/footer/Docs.mdx index cae3139..5f783f4 100644 --- a/src/scss/components/footer/Docs.mdx +++ b/src/scss/components/footer/Docs.mdx @@ -6,7 +6,7 @@ import * as ComponentStories from "./footer.stories"; -The footer of an IATI website may contain 1-3 sections, depending on what's needed for the application. Each section is optional, except the legal section. The order shown here must be respected. +The footer of an IATI website may contain 1-3 sections, depending on what's needed for the application. Each section is optional, except the legal section. The order shown here must be respected. The colours, fonts, images and other styles are an inherent part of the design and must be used when this design is used. @@ -24,12 +24,12 @@ Useful links might include a mini sitemap, related resources or signposts to alt ### Additional Information Section -Additional Information should include details of licensing, software versions, and short statements about the software, if relevant. +Additional Information should include details of licensing, software versions, and short statements about the software, if relevant. <Canvas of={ComponentStories.AdditionalInformationSection} /> ### Legal Section -The "Privacy" and "Data Removal" links must be included and link to the URLs provided here. If license information is not provided elsewhere in the footer it may be included here. The language switcher and social media links must be included. +The "Privacy" and "Data Removal" links must be included and link to the URLs provided here. If license information is not provided elsewhere in the footer it may be included here. The language switcher and social media links must be included. <Canvas of={ComponentStories.LegalSection} /> diff --git a/src/scss/components/header/Docs.mdx b/src/scss/components/header/Docs.mdx index 62261e8..118ed2f 100644 --- a/src/scss/components/header/Docs.mdx +++ b/src/scss/components/header/Docs.mdx @@ -6,16 +6,16 @@ import * as ComponentStories from "./header.stories"; <Title /> -The IATI Tools header is for use on all IATI-branded tools. By using the same header on all tools, we're creating a more consistent experience for people using those tools and helping them be more confident moving between tools. +The IATI Tools header is for use on all IATI-branded tools. By using the same header on all tools, we're creating a more consistent experience for people using those tools and helping them be more confident moving between tools. -Consistency across products is key, so the header should be used as-is without modification (including colours, fonts, icons and the "IATI Tools" label) except where described below. +Consistency across products is key, so the header should be used as-is without modification (including colours, fonts, icons and the "IATI Tools" label) except where described below. -The language switcher must be included even if the tool is only available in one language. The Help Docs and Search must be used to access those function if the application supports them, but may be omitted otherwise. No other buttons may be added to the header. +The language switcher must be included even if the tool is only available in one language. The Help Docs and Search must be used to access those function if the application supports them, but may be omitted otherwise. No other buttons may be added to the header. -The "IATI Tools" label must remain intact, and the Tool Name in the design replaced with the name of the tool. +The "IATI Tools" label must remain intact, and the Tool Name in the design replaced with the name of the tool. -The first link in the menu must return to the tool's home page. Further links are for primary navigation in the tool. No secondary navigation is supported in the header; this is left to the tool to provide. +The first link in the menu must return to the tool's home page. Further links are for primary navigation in the tool. No secondary navigation is supported in the header; this is left to the tool to provide. -If breadcrumbs are to be used, these should be directly below the header. +If breadcrumbs are to be used, these should be directly below the header. <Canvas of={ComponentStories.Header} /> diff --git a/src/usage.mdx b/src/usage.mdx index 8c9f21e..07fd6a2 100644 --- a/src/usage.mdx +++ b/src/usage.mdx @@ -5,9 +5,9 @@ import * as ButtonStories from "./scss/components/button/button.stories"; <Title>Using the IATI Design System -The IATI Design System is intended to increase the visual consistency of the IATI web estate and make it easier for people to navigate unfamiliar tools by providing consistent locations and hints as to where functionality can be found. +The IATI Design System is intended to increase the visual consistency of the IATI web estate and make it easier for people to navigate unfamiliar tools by providing consistent locations and hints as to where functionality can be found. -It is continuously being updated. If, when updating a website to use the design system, you find that an important question is unanswered, open a GitHub issue to discuss. In the meantime, continue to use your best judgement for the task at hand. +It is continuously being updated. If, when updating a website to use the design system, you find that an important question is unanswered, open a GitHub issue to discuss. In the meantime, continue to use your best judgement for the task at hand. After completing the installation instructions, core styles, such as typography, should be applied to your site.