From 44245dbfcca9bb52a2f9aba14b1aa66af560e411 Mon Sep 17 00:00:00 2001 From: Stephan Lo Date: Wed, 12 Nov 2025 09:03:10 +0100 Subject: [PATCH] docs(structure): WiP added more ideas for the content structure --- content/en/docs/platform-overview.md | 21 ++++++++++++++++----- 1 file changed, 16 insertions(+), 5 deletions(-) diff --git a/content/en/docs/platform-overview.md b/content/en/docs/platform-overview.md index 936db9c..bfb786a 100644 --- a/content/en/docs/platform-overview.md +++ b/content/en/docs/platform-overview.md @@ -1,21 +1,32 @@ --- -title: "Platform Documentation Overview" -description: "Comprehensive guide for users and auditors to understand and use the platform." +title: "eDF Documentation Overview" +description: "Comprehensive guide for users and auditors to understand and use the eDF." --- +# Meta + +## Guidelines + +1. for users/developers/engineers we describe our output / outcome as product + * it is usable + * there are links / lists to repos +2. we have and describe a 'product-structure-tree' +3. for auditors we have a list / cross reference to Jira tickets + # Introduction -- Purpose of the platform +- Purpose of the eDF - Target audience (developers, engineers, auditors) +- High-level product structure overview - High-level architecture overview -# Platform Components Overview +# eDF Components Overview - List of all major components - Vertical and horizontal layers explained - Component maturity/status (fully integrated, partial, experimental) # Getting Started - Quickstart guide for developers -- Onboarding steps for platform engineers +- Onboarding steps for eDF engineers - Prerequisites and environment setup # Component Details