Skip to content

Commit

Permalink
Linting
Browse files Browse the repository at this point in the history
  • Loading branch information
robredpath committed Jan 10, 2025
1 parent 109805a commit 7ca3213
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 11 deletions.
6 changes: 3 additions & 3 deletions src/scss/components/footer/Docs.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ import * as ComponentStories from "./footer.stories";

<Title />

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.

Expand All @@ -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} />
12 changes: 6 additions & 6 deletions src/scss/components/header/Docs.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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} />
4 changes: 2 additions & 2 deletions src/usage.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@ import * as ButtonStories from "./scss/components/button/button.stories";

<Title>Using the IATI Design System</Title>

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 <a href="../?path=/docs/installation--docs">installation</a> instructions, core styles, such as typography, should be applied to your site.

Expand Down

0 comments on commit 7ca3213

Please sign in to comment.