kpg/2026-001
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Refactor README structure for clarity and consistency in guidance sections

Browse Source
This commit is contained in:
Csaba Fabian 2026-03-08 11:53:45 +01:00
parent 73ec119a58
commit 04b1011b1f
1 changed files with 12 additions and 28 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

40
README.md
View File

@ -3,43 +3,27 @@
## General ## General
- Hints can be 5-10 lines long and multiple paragraphs. Can contain references to the source material. - 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 ## Page structure
1. Guidance (guidance.md) 01-*-epg-guidance.md (amber box)
02-*-kpg-principle.md (sky box)
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. 03-*-...md onwards (other guidance boxes)
Avoid using tables in this section. 04-*-einleitung.md (markdown block)
... content blocks (markdown, reflection, etc.)
2. KPG Guidance 99-*-quality-check.md (slate box)
vertical-hint-column.md (always visible on the right side of the page, contains the guidance section)
- 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"
### EPG Guidance
Provide a concise summary of the key concepts and principles of EPG related to the page, detailing the scoring criteria. 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. This is the **only** place where scoring criteria should be mentioned.
4. Einleitungsabsatz ### KPG Guidance
Provide a concise summary of the key concepts and principles of KPG related to the page.
- type: "markdown"
### Einleitungsabsatz
This is the section where the user describes the goal of the current chapter. Provide a hint accordingly. No footnote is necessary here. This is the section where the user describes the goal of the current chapter. Provide a hint accordingly. No footnote is necessary here.
... ### Qualitätsprüfung
Content boxes, prepended by guidance boxes if necessary.
...
N. Qualitätsprüfung
- type: "guidance-box"
- variant: "slate"
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. 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. Do not repeat the scoring points here.