From fafd386961f859e7d23642900b6df00dbeb897fa Mon Sep 17 00:00:00 2001 From: Phil Reed Date: Thu, 16 Jan 2025 10:42:43 +0000 Subject: [PATCH] Added news of SEEK docs updates --- ...rovements-to-documentation-fairdom-seek.md | 34 ++++ images/news/seek-docs-banner.svg | 160 ++++++++++++++++++ 2 files changed, 194 insertions(+) create mode 100644 _news/2025-01-16-improvements-to-documentation-fairdom-seek.md create mode 100644 images/news/seek-docs-banner.svg diff --git a/_news/2025-01-16-improvements-to-documentation-fairdom-seek.md b/_news/2025-01-16-improvements-to-documentation-fairdom-seek.md new file mode 100644 index 00000000..08780250 --- /dev/null +++ b/_news/2025-01-16-improvements-to-documentation-fairdom-seek.md @@ -0,0 +1,34 @@ +--- +title: "Improvements to documentation for FAIRDOM-SEEK (navigation and design)" +--- + +We are delighted to announce that a phase of improvements to the FAIRDOM-SEEK documentation is ready. + +[![FAIRDOM-SEEK documentation banner](/images/news/seek-docs-banner.svg)](https://docs.seek4science.org/) + +* [View the improved FAIRDOM-SEEK documentation](https://docs.seek4science.org/) + +This update focuses on navigation, design and search. +We are using the [ELIXIR Toolkit Theme](https://elixir-belgium.github.io/elixir-toolkit-theme/) with custom styling for FAIRDOM-SEEK. +All the old page paths still work. There is minimal change to the Markdown of all pages. The folder structure is the same. + +## Design, layout and search + +* There is a new **search box** at the top of all pages, with instant results. +* There is a **table of contents** on the right-side to jump to headings within a page. +* You can **scroll to the top** of the page with a button at the bottom-right. +* The fonts and colours have been maintained. + +## Navigation menus + +* There is a new **top navigation** linking to the main sections [User Guide](https://docs.seek4science.org/help/user-guide/) and [Technical References](https://docs.seek4science.org/tech/). +* There is a **side navigation** left within each section, listing all pages. +* There is a **footer navigation** including more links than the top navigation. +* The navigation adapts to mobile/tablet devices. + +## Your contributions are welcome + +We continue to welcome [contributions to the documentation](https://docs.seek4science.org/contributing-to-pages), +particularly from people who manage their own FAIRDOM-SEEK instance. +The contribution guide has been updated to reflect the minor differences required for new pages, +for example, we no longer include the `.html` part of the path when linking to other pages on the site. diff --git a/images/news/seek-docs-banner.svg b/images/news/seek-docs-banner.svg new file mode 100644 index 00000000..0457b814 --- /dev/null +++ b/images/news/seek-docs-banner.svg @@ -0,0 +1,160 @@ + + + + + + + + + + + + + + + + + + + + + +