From ef5f8bd53d77e1cf2310b2b23b8d95ad5899e70b Mon Sep 17 00:00:00 2001 From: Antoine Lambert <anlambert@softwareheritage.org> Date: Tue, 26 Nov 2024 12:30:43 +0100 Subject: [PATCH] 20240701_faq.md: Ensure to have level 1 heading This is used by the markdown importer on our WordPress website to set the FAQ page title. When it is missing, the FAQ title page is reset to an empty string when the document is updated. --- 20240701_faq.md | 5 ++--- README.md | 2 -- 2 files changed, 2 insertions(+), 5 deletions(-) diff --git a/20240701_faq.md b/20240701_faq.md index 5e6c76f..390bfaa 100644 --- a/20240701_faq.md +++ b/20240701_faq.md @@ -17,11 +17,10 @@ Slight changes have to be made. See questions in: https://hedgedoc.softwareheritage.org/6hFGAHdUTY2wWKr5OqwzkQ?both# - -# FAQ Software Heritage (website) - ---> +# FAQ + ## 1. General ### 1.1 What is Software Heritage? diff --git a/README.md b/README.md index 93344e1..f6a9b29 100644 --- a/README.md +++ b/README.md @@ -14,5 +14,3 @@ E.g.: what is software source code? why archiving software source code? how do y The full FAQ, with some unpublished content waiting for review, is available on [faq.md](faq.md) while the published FAQ is available on [20240701_faq.md](20240701_faq.md), section 1 to 5 are already online on https://www.softwareheritage.org/faq/. The content of each FAQ page (one per supported language) located at https://www.softwareheritage.org/faq/ is dynamically generated from associated markdown file in that repository, every change pushed to is automatically taken into account when refreshing the published FAQ page. - -To be noted, for a proper display of a FAQ page in the main Software Heritage website, the associated markdown document should start with a level 2 heading (`## section title`). \ No newline at end of file -- GitLab