summaryrefslogtreecommitdiffhomepage
path: root/docs
diff options
context:
space:
mode:
authorAmlal El Mahrouss <amlal@nekernel.org>2025-12-18 09:04:13 +0100
committerAmlal El Mahrouss <amlal@nekernel.org>2025-12-18 09:04:13 +0100
commited6d2f6007b572b907e3cb11b4303c13d1572c9c (patch)
tree47f177336db980a138a91a2fb109db8f1a65086c /docs
parent3a5c7473910156051951f8ec98488a6c91a3eabd (diff)
chore: specification updates and patches on the DDK, new source `ddk_c++.cc`.
Signed-off-by: Amlal El Mahrouss <amlal@nekernel.org>
Diffstat (limited to 'docs')
-rw-r--r--docs/specs/SPECIFICATION_FWRK.md16
-rw-r--r--docs/specs/SPECIFICATION_MBCI.md6
-rw-r--r--docs/specs/SPECIFICATION_OS.md (renamed from docs/specs/SPECIFICATION_KERNEL.md)15
-rw-r--r--docs/tex/NOTICE.md6
4 files changed, 25 insertions, 18 deletions
diff --git a/docs/specs/SPECIFICATION_FWRK.md b/docs/specs/SPECIFICATION_FWRK.md
index b506b266..8d95abc7 100644
--- a/docs/specs/SPECIFICATION_FWRK.md
+++ b/docs/specs/SPECIFICATION_FWRK.md
@@ -9,15 +9,17 @@
===================================
-# 1: The specification
+# 1: The specification:
===================================
-## Overview
-
The NeKernel framework system (`.fwrk`) provides a standardized structure for creating modular, reusable libraries and components. Frameworks are self-contained packages that include headers, source code, metadata, and configuration for compilation and deployment within the NeKernel ecosystem.
-## Framework Directory Structure
+==================================
+
+# 2: Framework Directory Structure:
+
+==================================
Each framework follows the standardized directory layout below:
@@ -38,7 +40,11 @@ Each framework follows the standardized directory layout below:
└── .keep # Placeholder file
```
-## Component Specifications
+================================
+
+# 3: Component Specifications
+
+================================
### 1. Framework Manifest (`<FrameworkName>.json`)
diff --git a/docs/specs/SPECIFICATION_MBCI.md b/docs/specs/SPECIFICATION_MBCI.md
index 63452a85..648529cf 100644
--- a/docs/specs/SPECIFICATION_MBCI.md
+++ b/docs/specs/SPECIFICATION_MBCI.md
@@ -1,6 +1,6 @@
===================================
-# 0: General Information
+# 0: General Information:
===================================
@@ -10,7 +10,7 @@
===================================
-# 1: Concepts
+# 1: Concepts:
===================================
@@ -20,7 +20,7 @@
===================================
-# 2: Pinout
+# 2: Pinout:
===================================
diff --git a/docs/specs/SPECIFICATION_KERNEL.md b/docs/specs/SPECIFICATION_OS.md
index fe2cb9da..313ba342 100644
--- a/docs/specs/SPECIFICATION_KERNEL.md
+++ b/docs/specs/SPECIFICATION_OS.md
@@ -1,6 +1,6 @@
===================================
-# 0: General Information
+# 0: General Information:
===================================
@@ -17,7 +17,7 @@
- Drive/Device Abstraction.
- SMP, Preemptive Multi Threading.
- Separation of Files/Devices.
-- Networking.
+- Networking Support.
- Hardware Abstraction Layer.
- Native Filesystem support (NeFS, FAT32 and ffs2).
- Program Loaders interfaces.
@@ -27,10 +27,11 @@
- Dynamic Loader.
- Cross Platform.
- Permission Selectors.
+- Modular, and Security focused.
===================================
-# 2: The Filesystem (NeFS)
+# 2: The Filesystem (NeFS, OpenHeFS)
===================================
@@ -42,7 +43,7 @@
==================================
-# 3: Common naming conventions:
+# 3: Common conventions:
==================================
@@ -50,8 +51,7 @@
- RunTime -> rt_copy_mem
- Hal -> hal_foo_bar
- Class methods -> Class::FooBar
-
-Internals function shall be formated as such: (hali, rtli, rti...)
+- Internals function shall be formated as such: (hali, rtli, rti...)
===================================
@@ -60,7 +60,8 @@ Internals function shall be formated as such: (hali, rtli, rti...)
===================================
- Capable of booting from a network drive.
-- Loads a PE file which is the Kernel.
+- Loads a PE file which is the Kernel, or any modules.
- Sanity checks, based on the number of sections.
- Handover compliant.
- Does check for a valid partition (useful in the case of recovering)
+- Modular, and Security focused.
diff --git a/docs/tex/NOTICE.md b/docs/tex/NOTICE.md
index a556bfef..23417d2a 100644
--- a/docs/tex/NOTICE.md
+++ b/docs/tex/NOTICE.md
@@ -1,8 +1,8 @@
-# Notice
+# Notice: NeKernel specifications.
-## CoreProcessScheduler has moved!
+## Notice: CoreProcessScheduler paper.
-The CPS is now part of WG02, for more information clone the following repository: [https://github.com/nekernel-org/draft](https://github.com/nekernel-org/draft).
+The CPS has been moved to WG02,for more information, clone the following repository: [https://github.com/nekernel-org/draft](https://github.com/nekernel-org/draft).
## Recommended: