md-files: modify .md files after linter check

SorinOlari · kr-t · commit 0fc5d5d2ac20 · 2026-03-12T10:43:20.000+01:00
Signed-off-by: SorinO &lt;sorin.olari2@gmail.com&gt;
diff --git a/.github/CODE_OF_CONDUCT.md b/.github/CODE_OF_CONDUCT.md
@@ -7,4 +7,4 @@ SPDX-License-Identifier: Apache-2.0 -->
 
 Ocre is a project of Linux Foundation Edge and applies the [LF Edge Contributor Code of Conduct](https://www.lfedge.org/governance/code-of-conduct/).
 
-Please reach out to Ocre-TSC+help@lists.lfedge.org in the event of any Code of Conduct violations or concerns. All communications will be kept confidential.
+Please reach out to Ocre-TSC+help@lists.lfedge.org in the event of any Code of Conduct violations or concerns. All communications will be kept confidential.
diff --git a/.github/ISSUE_TEMPLATE/10_question.md b/.github/ISSUE_TEMPLATE/10_question.md
@@ -1,6 +1,6 @@
 ---
 name: Question
-about: Ask a question about Ocre 
+about: Ask a question about Ocre
 title: ''
 labels: question
 assignees: ''
@@ -9,4 +9,4 @@ assignees: ''
 
 Make sure to check the [readme](https://github.com/project-ocre/ocre-runtime/blob/master/README.md) first. If the question is concise and probably has a short answer, asking it in our [slack channel](https://lfedge.slack.com/archives/C07F190CC3X) is probably the fastest way to find the answer.
 
-If you still prefer GitHub issues, remove all this text and ask your question here.
+If you still prefer GitHub issues, remove all this text and ask your question here.
diff --git a/.github/ISSUE_TEMPLATE/30_bug-report.md b/.github/ISSUE_TEMPLATE/30_bug-report.md
@@ -1,20 +1,18 @@
 ---
 name: Bug report
-about: Create a report to help us improve Ocre 
+about: Create a report to help us improve Ocre
 title: ''
 labels: bug
 assignees: ''
 
 ---
 
-
 Please provide information requested in the template below as much as possible.
 
 #### Describe the bug
 
 A clear and concise description of the problem.
 
-
 #### Duplicate
 
 If you are reporting a new issue, make sure that we do not have any duplicates
@@ -36,4 +34,4 @@ If applicable, add screenshots to help explain your problem.
 
 #### Additional context
 
-Add any other information about the problem here.
+Add any other information about the problem here.
diff --git a/.github/ISSUE_TEMPLATE/40_security_task.md b/.github/ISSUE_TEMPLATE/40_security_task.md
@@ -6,23 +6,29 @@ labels: security
 assignees: ''
 ---
 
-#### Security Issue Description  
+#### Security Issue Description
+
 Provide a brief description of the security concern or task.
 
-#### Affected Components  
+#### Affected Components
+
 List any relevant components, services, or dependencies impacted.
 
-#### Severity & Impact  
+#### Severity & Impact
+
 - [ ] Low - Minor security concern, limited impact
 - [ ] Medium - Potential risk, but not critical
 - [ ] High - Significant risk, requires immediate attention
 - [ ] Critical - Severe vulnerability, urgent resolution needed
 
-#### Steps to Reproduce (if applicable)  
+#### Steps to Reproduce (if applicable)
+
 If reporting a vulnerability or bug, provide steps to reproduce the issue.
 
-#### Suggested Remediation  
+#### Suggested Remediation
+
 Provide any suggested fixes, mitigations, or security best practices to address the issue.
 
-#### Additional Context  
+#### Additional Context
+
 Any other relevant information, links to related issues, reference materials, or CVEs.
diff --git a/.github/ISSUE_TEMPLATE/50_unhiol_task.md b/.github/ISSUE_TEMPLATE/50_unhiol_task.md
@@ -7,14 +7,18 @@ assignees: ''
 ---
 
 #### Task Description
+
 Brief description of the issue or task needed.
 
 #### Requirements
+
 - [ ] Requirement 1
 - [ ] Requirement 2
 
 #### Expected Outcome
+
 What should be the end result of this task?
 
 #### Additional Context
+
 Any other relevant information, links to related issues, or reference materials.
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -9,7 +9,7 @@ Please include a summary of the change and which issue is fixed. Please also inc
 
 Also, please list any issue that this PR is intended to fix.
 
-- Fixes issue # 
+- Fixes issue #
 
 ## Type of change
 
@@ -24,12 +24,14 @@ Please delete options that are not relevant.
 - [ ] Test Coverage update
 
 # How Has This Been Tested?
-Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration including the following required details. 
+
+Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration including the following required details.
 
 **Test Configuration (required)**:
-* Host OS type, version, and arch: `Ubuntu 20.04 (arm64)`
-* Developer Board make & model: `ST Nucleo h723zg`
-* Board Tools Installed: `STM32CubeProgrammer`)
+
+- Host OS type, version, and arch: `Ubuntu 20.04 (arm64)`
+- Developer Board make & model: `ST Nucleo h723zg`
+- Board Tools Installed: `STM32CubeProgrammer`
 
 # Checklist:
 
@@ -39,4 +41,4 @@ Please describe the tests that you ran to verify your changes. Provide instructi
 - [ ] I have made corresponding changes to the documentation
 - [ ] My changes generate no new warnings
 - [ ] I have added tests that prove my fix is effective or that my feature works
-- [ ] New and existing unit tests pass locally with my changes
+- [ ] New and existing unit tests pass locally with my changes
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -3,7 +3,7 @@ which has been established as Project Ocre a Series of LF Projects, LLC
 
 SPDX-License-Identifier: Apache-2.0 -->
 
-# Contributing to Ocre 
+# Contributing to Ocre
 
 The Ocre community shares the spirit of the [Apache Way](https://apache.org/theapacheway/)
 and believes in "Community over Code". We welcome any and all types of contributions
@@ -70,7 +70,7 @@ replace those parts with "REDACTED").
 
 The Ocre community takes security seriously. If you discover a security issue, please bring it to our attention right away!
 
-Please *DO NOT* file a public issue, instead send your report privately to [Ocre-TSC+owner@lists.lfedge.org](mailto:Ocre-TSC+owner@lists.lfedge.org). 
+Please *DO NOT* file a public issue, instead send your report privately to [Ocre-TSC+owner@lists.lfedge.org](mailto:Ocre-TSC+owner@lists.lfedge.org).
 
 ## Code contributions
 
@@ -84,8 +84,8 @@ that may be out of scope for the project.
 
 Not sure if that typo is worth a pull request? Found a bug and know how to fix
 it? Do it! We will appreciate it. We are always thrilled to receive pull requests.
-We do our best to process them quickly. When creating your PR, please tag relevant 
-maintainers from our [MAINTAINERS.md](https://github.com/project-ocre/ocre-runtime/blob/main/MAINTAINERS.md) file. 
+We do our best to process them quickly. When creating your PR, please tag relevant
+maintainers from our [MAINTAINERS.md](https://github.com/project-ocre/ocre-runtime/blob/main/MAINTAINERS.md) file.
 If your pull request is not accepted on the first try, don't get discouraged!
 
 ### Commit Messages
diff --git a/MAINTAINERS.md b/MAINTAINERS.md
@@ -10,6 +10,7 @@ This page lists all active maintainers (also known as committers) of the [Ocre P
 For governance guidelines and information on becoming a committer/maintainer, see the [Ocre Wiki](https://lf-edge.atlassian.net/wiki/spaces/OCRE/overview). For general contribution guidelines, refer to [CONTRIBUTING.md](https://github.com/project-ocre/ocre-runtime/blob/master/CONTRIBUTING.md).
 
 ## Active Maintainers
+
 | Name | GitHub Username | Email |
 |------|-------|-----------|
 | Stephen Berard | @sberard | stephen@atym.io |
diff --git a/SECURITY.md b/SECURITY.md
@@ -9,8 +9,8 @@ SPDX-License-Identifier: Apache-2.0 -->
 
 The Ocre community takes security seriously. If you discover a security issue, please bring it to our attention right away!
 
-Please DO NOT file a public issue, instead send your report privately to Ocre-TSC+owner@lists.lfedge.org. 
+Please DO NOT file a public issue, instead send your report privately to Ocre-TSC+owner@lists.lfedge.org.
 
 ## Security Overview
 
-The main Ocre repo's [CONTRIBUTING.md](https://github.com/project-ocre/ocre-runtime/blob/master/CONTRIBUTING.md) has additional information about contributions and security approaches.
+The main Ocre repo's [CONTRIBUTING.md](https://github.com/project-ocre/ocre-runtime/blob/master/CONTRIBUTING.md) has additional information about contributions and security approaches.
diff --git a/docs/BuildSystemLinux.md b/docs/BuildSystemLinux.md
@@ -14,11 +14,11 @@ However, for [memory leak checks](tests/LeakChecks.md) and [source code test cov
 
 This file described the generic configuration that is used by Ocre Library or the builds described above.
 
-### Configuration
+## Configuration
 
 This sections describes the build-time configuration honored by samples and tests in Linux.
 
-#### Version
+### Version
 
 There are several components of the Ocre version that gets compiled in the project.
 
@@ -29,20 +29,20 @@ If the file does not exist, and the source tree is not a valid git repository, t
 
 Check [Versioning](Versioning.md) documentation for more information.
 
-#### Ocre build Configuration
+### Ocre build Configuration
 
 The default Ocre build configuration is in the file `src/platform/posix/include/ocre/platform/config.h`.
 These options should not be changed by the user and the defaults should be used.
 
-#### build-time variables
+### build-time variables
 
 Some relevant build-time variables are described below:
 
 - `OCRE_INPUT_FILE_NAME`: Absolute path to the container file to be executed by the mini sample application.
 - `OCRE_PRELOADED_IMAGES`: List of absolute paths images to be added to the state information directory.
 - `OCRE_SDK_PRELOADED_IMAGES`: List of ocre-sdk submodule target images to be added to the state information directory.
 
-#### State information directory
+### State information directory
 
 In Linux, the [state information](StateInformation.md) is usually stored by default in `/var/run/ocre` if Ocre is installed as a system service. For tests, these are usually stored relative to the build directory.
 
diff --git a/docs/GetStartedZephyr.md b/docs/GetStartedZephyr.md
@@ -74,6 +74,7 @@ west update
 ```
 
 Now, clone Ocre runtime:
+
 ```sh
 git clone --recurse-submodules https://github.com/project-ocre/ocre-runtime.git
 ```
diff --git a/docs/boards/zephyr/b_u585i_iot02a.md b/docs/boards/zephyr/b_u585i_iot02a.md
@@ -90,7 +90,7 @@ Start with [Getting Started with Zephyr](../../GetStartedZephyr.md) to get a wor
 For development or testing without networking:
 
 ```bash
-west build -p always -b b_u585i_iot02a src/samples/supervisor/zephyr/ 
+west build -p always -b b_u585i_iot02a src/samples/supervisor/zephyr/
 ```
 
 ### Building with ENC28J60 Ethernet Shield
@@ -156,21 +156,21 @@ ls /dev/ttyACM*
 WSL does not automatically expose USB serial devices.
 You must attach the ST-Link device using `usbipd`.
 
-**1. Install usbipd on Windows**
+#### 1. Install usbipd on Windows
 
 From PowerShell (Admin):
 
 ```bash
 winget install usbipd
 ```
 
-**2. List USB devices**
+#### 2. List USB devices
 
 ```bash
 usbipd list
 ```
 
-**3. Attach device to WSL (look for ST-Link / STMicroelectronics)**
+#### 3. Attach device to WSL (look for ST-Link / STMicroelectronics)
 
 ```bash
 usbipd attach --busid <BUS_ID> --wsl
@@ -182,7 +182,7 @@ Example:
 usbipd attach --busid 1-4 --wsl
 ```
 
-**4. Verify in WSL**
+#### 4. Verify in WSL
 
 ```bash
 ls /dev/ttyACM*
diff --git a/docs/boards/zephyr/native_sim.md b/docs/boards/zephyr/native_sim.md
@@ -60,6 +60,7 @@ To build for the 32-bit `native_sim` variant on a 64-bit system, install `gcc-mu
 ```bash
 sudo apt install gcc-multilib
 ```
+
 **Note:** this is not required for 32-bit systems.
 
 ### Building with TAP Networking (Default)
@@ -69,6 +70,7 @@ To build native_sim with TAP networking:
 ```bash
 west build -p always -b native_sim/native/64 src/samples/supervisor/zephyr/
 ```
+
 Alternatively, the `native_sim` board could be used for supported 32-bit platforms.
 
 ### Building with NSOS Networking
@@ -78,6 +80,7 @@ To build native_sim with Native Sockets (NSOS):
 ```bash
 west build -p always -b native_sim/native/64 src/samples/supervisor/zephyr/ -- -DEXTRA_CONF_FILE=boards/overlay-nsos.conf
 ```
+
 Alternatively, the `native_sim` board could be used for supported 32-bit platforms.
 
 ## Running the Simulation
diff --git a/docs/tests/SystemTests.md b/docs/tests/SystemTests.md
@@ -73,6 +73,7 @@ Please, refer to their source code for more details.
 ## Zephyr
 
 ### Build and run
+
 To build the Zephyr system tests for the `native_sim_64` board:
 
 ```sh
@@ -87,16 +88,19 @@ Replace `context` with `container`, `lib`, or `ocre` to build different tests:
 - `tests/system/zephyr/container` - Tests the specific functionality of a container
 
 To run the test:
+
 ```sh
 west build -t run
 ```
 
 The last lines of the output will be something like:
+
 ```
 -----------------------
-25 Tests 0 Failures 0 Ignored 
+25 Tests 0 Failures 0 Ignored
 OK
 ```
 
 ### Details
+
 Each test must be run individually. Run the build command for one test at a time, then execute `west build -t run` to run that specific test.
diff --git a/tests_hw/README.md b/tests_hw/README.md
@@ -3,11 +3,11 @@ which has been established as Project Ocre a Series of LF Projects, LLC
 
 SPDX-License-Identifier: Apache-2.0 -->
 
-## Overview
+# Overview
 
 In the Ocre testing framework, the Ocre execution is comprised of test groups, test suites, and test cases.
 
-Test groups represent a group of test suites which have the same environmental prerequisites, and require a 
+Test groups represent a group of test suites which have the same environmental prerequisites, and require a
 common setup and teardown process, e.g. the Flash Validation test group requires that the DUT board has been
 flashed with the Ocre runtime. Test groups will block each other on failure, meaning that if a test group
 fails, all subsequent test groups will be skipped.
@@ -20,16 +20,15 @@ Test cases are the individual tests, and are literally a python or bash script (
 some arbitrary code according to the test plan, and then exits / returns an exit code of 0 on success and 1 on
 failure.
 
-## Adding Test Groups, Test Suites, and Test Cases.
+# Adding Test Groups, Test Suites, and Test Cases
 
-To add a test group, you must create a new directory under the /tests/ dir, named after the new test group. Then, 
+To add a test group, you must create a new directory under the /tests/ dir, named after the new test group. Then,
 add a config.json file in the directory according to the format given below. Finally, add a step to the
-/.github/workflows/tests.yml file which runs the beginTests.sh against your new test group. 
+/.github/workflows/tests.yml file which runs the beginTests.sh against your new test group.
 
 To add a new testcase, the only requirement is that the testcase script file be placed under a testgroup dir, and
 that it exits with 0 on success and 1 on failure.
 
-
 ```json
 {
   "name": "Name of test group",

Original file line number	Diff line number	Diff line change
`@@ -7,4 +7,4 @@ SPDX-License-Identifier: Apache-2.0 -->`
`7`	`7`
`8`	`8`	`Ocre is a project of Linux Foundation Edge and applies the [LF Edge Contributor Code of Conduct](https://www.lfedge.org/governance/code-of-conduct/).`
`9`	`9`
`10`		`-Please reach out to Ocre-TSC+help@lists.lfedge.org in the event of any Code of Conduct violations or concerns. All communications will be kept confidential.`
	`10`	`+Please reach out to Ocre-TSC+help@lists.lfedge.org in the event of any Code of Conduct violations or concerns. All communications will be kept confidential.`