From 04b1011b1fe00f7f95f18b0fca71c6ff7baf7778 Mon Sep 17 00:00:00 2001 From: Csaba Fabian Date: Sun, 8 Mar 2026 11:53:45 +0100 Subject: [PATCH] Refactor README structure for clarity and consistency in guidance sections --- README.md | 40 ++++++++++++---------------------------- 1 file changed, 12 insertions(+), 28 deletions(-) diff --git a/README.md b/README.md index 3d29d48..9b0daed 100644 --- a/README.md +++ b/README.md @@ -3,43 +3,27 @@ ## General - Hints can be 5-10 lines long and multiple paragraphs. Can contain references to the source material. -- Footnotes should contain a one-liner that provides additional information about the content expected in the markdown block. Always start with an icon that gives a quick visual hint about the content of the footnote. No references here. ## Page structure -1. Guidance (guidance.md) - -This section will always be visible while the user is on this page. Provide a short explanation, list of quick references and a TODO checklist. -Avoid using tables in this section. - -2. KPG Guidance - -- type: "guidance-box" -- variant: "sky" - -Provide a concise summary of the key concepts and principles of KPG related to the page. - -3. EPG Guidance - -- type: "guidance-box" -- variant: "amber" +01-*-epg-guidance.md (amber box) +02-*-kpg-principle.md (sky box) +03-*-...md onwards (other guidance boxes) +04-*-einleitung.md (markdown block) +... content blocks (markdown, reflection, etc.) +99-*-quality-check.md (slate box) +vertical-hint-column.md (always visible on the right side of the page, contains the guidance section) +### EPG Guidance Provide a concise summary of the key concepts and principles of EPG related to the page, detailing the scoring criteria. This is the **only** place where scoring criteria should be mentioned. -4. Einleitungsabsatz - -- type: "markdown" +### KPG Guidance +Provide a concise summary of the key concepts and principles of KPG related to the page. +### Einleitungsabsatz This is the section where the user describes the goal of the current chapter. Provide a hint accordingly. No footnote is necessary here. -... -Content boxes, prepended by guidance boxes if necessary. -... - -N. Qualitätsprüfung -- type: "guidance-box" -- variant: "slate" - +### Qualitätsprüfung The final checklist to ensure that all necessary elements are included and correctly filled out on the page. This should be a comprehensive list that covers all aspects of the page's content and structure, ensuring that it meets the standards for both KPG and EPG. Do not repeat the scoring points here.