[doc] Rewrite most frontmatters to Markdown titles
Completely throw away the frontmatter and only keep the title which is
turned into a Markdown title.
To recreate the rewrite, run the added script,
`util/rewrite_frontmatter.py`, in the root of the repo.
```sh
python3 util/rewrite_frontmatter.py ./
```
Signed-off-by: Hugo McNally <hugo.mcnally@gmail.com>
Co-authored-by: Amaury Pouly <amaury.pouly@lowrisc.org>
diff --git a/doc/contributing/README.md b/doc/contributing/README.md
index fae9f5d..ac8f089 100644
--- a/doc/contributing/README.md
+++ b/doc/contributing/README.md
@@ -1,6 +1,4 @@
----
-title: Contributing to OpenTitan
----
+# Contributing to OpenTitan
Thank you for your interest in contributing to OpenTitan.
This document provides some guidelines to making those contributions.
diff --git a/doc/contributing/bazel_notes.md b/doc/contributing/bazel_notes.md
index d589fe8..92cc105 100644
--- a/doc/contributing/bazel_notes.md
+++ b/doc/contributing/bazel_notes.md
@@ -1,6 +1,4 @@
----
-title: Bazel Notes
----
+# Bazel Notes
Both OpenTitan hardware and software is built with Bazel.
While our [Getting Started](https://docs.opentitan.org/doc/guides/getting_started/) guides detail some of the Bazel commands that can be used to build both types of artifacts, below are detailed notes on:
diff --git a/doc/contributing/ci/README.md b/doc/contributing/ci/README.md
index 3e55385..7e56b3e 100644
--- a/doc/contributing/ci/README.md
+++ b/doc/contributing/ci/README.md
@@ -1,6 +1,4 @@
----
-title: "OpenTitan Continuous Integration"
----
+# OpenTitan Continuous Integration
All changes to the OpenTitan source code are tested thoroughly in a continuous integration system.
Tests run automatically when changes are proposed for inclusion by submitting a pull request, and on the `master` branch after changes are merged.
diff --git a/doc/contributing/detailed_contribution_guide/README.md b/doc/contributing/detailed_contribution_guide/README.md
index af81d3f..bcf9c81 100644
--- a/doc/contributing/detailed_contribution_guide/README.md
+++ b/doc/contributing/detailed_contribution_guide/README.md
@@ -1,6 +1,4 @@
----
-title: "In-depth guide to contributing to OpenTitan"
----
+# In-depth guide to contributing to OpenTitan
The way we work on OpenTitan is very similar to what is done in other collaborative open-source projects.
For a brief overview see [Contributing to OpenTitan](../README.md).
diff --git a/doc/contributing/directory_structure.md b/doc/contributing/directory_structure.md
index b893f3b..227785e 100644
--- a/doc/contributing/directory_structure.md
+++ b/doc/contributing/directory_structure.md
@@ -1,6 +1,4 @@
----
-title: "Directory Structure"
----
+# Directory Structure
This document provides an overview of the opentitan repository directory structure.
The hierarchy underneath the root is fairly self explanatory, containing the following:
diff --git a/doc/contributing/dv/methodology/README.md b/doc/contributing/dv/methodology/README.md
index 1272ce2..ea0853a 100644
--- a/doc/contributing/dv/methodology/README.md
+++ b/doc/contributing/dv/methodology/README.md
@@ -1,6 +1,4 @@
----
-title: "Design Verification Methodology within OpenTitan"
----
+# Design Verification Methodology within OpenTitan
Verification within OpenTitan combines the challenges of industry-strength verification methodologies with open source ambitions.
When in conflict, quality must win, and thus we aim to create a verification product that is equal to the quality required from a full production silicon chip tapeout.
diff --git a/doc/contributing/dv/sec_cm_dv_framework/README.md b/doc/contributing/dv/sec_cm_dv_framework/README.md
index 00adad2..3608517 100644
--- a/doc/contributing/dv/sec_cm_dv_framework/README.md
+++ b/doc/contributing/dv/sec_cm_dv_framework/README.md
@@ -1,6 +1,4 @@
----
-title: "Security Countermeasure Verification Framework"
----
+# Security Countermeasure Verification Framework
## Purpose
In a security chip, there are many hardening security countermeasures implemented in security blocks.
diff --git a/doc/contributing/fpga/get_a_board.md b/doc/contributing/fpga/get_a_board.md
index d7e05a6..91aab9c 100644
--- a/doc/contributing/fpga/get_a_board.md
+++ b/doc/contributing/fpga/get_a_board.md
@@ -1,6 +1,4 @@
----
-title: "Get an FPGA Board"
----
+# Get an FPGA Board
FPGA boards come at different price points, with the price being a good indicator for how much logic the FPGA can hold.
The following sections give details of how to obtain our supported FPGA boards.
diff --git a/doc/contributing/fpga/ref_manual_fpga.md b/doc/contributing/fpga/ref_manual_fpga.md
index 59039f0..8806199 100644
--- a/doc/contributing/fpga/ref_manual_fpga.md
+++ b/doc/contributing/fpga/ref_manual_fpga.md
@@ -1,6 +1,4 @@
----
-title: "FPGA Reference Manual"
----
+# FPGA Reference Manual
This manual provides additional usage details about the FPGA.
Specifically, it provides instructions on SW development flows and testing procedures.
diff --git a/doc/contributing/github_notes.md b/doc/contributing/github_notes.md
index c94ffc4..d24aae2 100644
--- a/doc/contributing/github_notes.md
+++ b/doc/contributing/github_notes.md
@@ -1,6 +1,4 @@
----
-title: GitHub Notes
----
+# GitHub Notes
The OpenTitan source tree is maintained on GitHub in a [monolithic repository](https://github.com/lowRISC/opentitan) called opentitan.
diff --git a/doc/contributing/hw/comportability/README.md b/doc/contributing/hw/comportability/README.md
index 7c7b95a..a997f18 100644
--- a/doc/contributing/hw/comportability/README.md
+++ b/doc/contributing/hw/comportability/README.md
@@ -1,6 +1,4 @@
----
-title: "Comportability Definition and Specification"
----
+# Comportability Definition and Specification
## Document Goals
diff --git a/doc/contributing/hw/design.md b/doc/contributing/hw/design.md
index c699c9e..14dd0d4 100644
--- a/doc/contributing/hw/design.md
+++ b/doc/contributing/hw/design.md
@@ -1,6 +1,4 @@
----
-title: "Designing Hardware"
----
+# Designing Hardware
This document aims to clarify how to get started with a hardware design within the OpenTitan project.
Design in this context nominally refers to a new [Comportable Peripheral](./comportability/README.md) but can include high level constructs like device reset strategy, etc.
diff --git a/doc/contributing/hw/methodology.md b/doc/contributing/hw/methodology.md
index e62829c..050c6dd 100644
--- a/doc/contributing/hw/methodology.md
+++ b/doc/contributing/hw/methodology.md
@@ -1,6 +1,4 @@
----
-title: "Design Methodology within OpenTitan"
----
+# Design Methodology within OpenTitan
The design methodology within OpenTitan combines the challenges of industry-strength design methodologies with open source ambitions.
When in conflict, quality must win, and thus we aim to create a final design product that is equal to the quality required from a full production silicon chip tapeout.
diff --git a/doc/contributing/hw/vendor.md b/doc/contributing/hw/vendor.md
index 8e33215..ba29437 100644
--- a/doc/contributing/hw/vendor.md
+++ b/doc/contributing/hw/vendor.md
@@ -1,6 +1,4 @@
----
-title: Work with hardware code in external repositories
----
+# Work with hardware code in external repositories
OpenTitan is not a closed ecosystem: we incorporate code from third parties, and we split out pieces of our code to reach a wider audience.
In both cases, we need to import and use code from external repositories in our OpenTitan code base.
diff --git a/doc/contributing/style_guides/README.md b/doc/contributing/style_guides/README.md
index 0bf80f9..adae309 100644
--- a/doc/contributing/style_guides/README.md
+++ b/doc/contributing/style_guides/README.md
@@ -1,6 +1,4 @@
----
-title: "Style Guides"
----
+# Style Guides
OpenTitan's CI enforces what it can of the following style guides to avoid conflict, toil and confusion.
However, code reviewers are also responsible for enforcing coding style guidelines and best practices.
diff --git a/doc/contributing/style_guides/asm_coding_style.md b/doc/contributing/style_guides/asm_coding_style.md
index daf16f9..2d768fc 100644
--- a/doc/contributing/style_guides/asm_coding_style.md
+++ b/doc/contributing/style_guides/asm_coding_style.md
@@ -1,6 +1,4 @@
----
-title: "RISC-V Assembly Style Guide"
----
+# RISC-V Assembly Style Guide
## Basics
diff --git a/doc/contributing/style_guides/c_cpp_coding_style.md b/doc/contributing/style_guides/c_cpp_coding_style.md
index 00e9925..aa9c110 100644
--- a/doc/contributing/style_guides/c_cpp_coding_style.md
+++ b/doc/contributing/style_guides/c_cpp_coding_style.md
@@ -1,6 +1,4 @@
----
-title: "C and C++ Coding Style Guide"
----
+# C and C++ Coding Style Guide
## Basics
diff --git a/doc/contributing/style_guides/guidance_for_volatile.md b/doc/contributing/style_guides/guidance_for_volatile.md
index 8d5635d..a2e5264 100644
--- a/doc/contributing/style_guides/guidance_for_volatile.md
+++ b/doc/contributing/style_guides/guidance_for_volatile.md
@@ -1,6 +1,4 @@
----
-title: "Guidance for `volatile` in OpenTitan Silicon Creator Code"
----
+# Guidance for `volatile` in OpenTitan Silicon Creator Code
## TL;DR
diff --git a/doc/contributing/style_guides/hjson_usage_style.md b/doc/contributing/style_guides/hjson_usage_style.md
index 9d4f1a8..9212bfe 100644
--- a/doc/contributing/style_guides/hjson_usage_style.md
+++ b/doc/contributing/style_guides/hjson_usage_style.md
@@ -1,6 +1,4 @@
----
-title: "Hjson Usage and Style Guide"
----
+# Hjson Usage and Style Guide
## Basics
diff --git a/doc/contributing/style_guides/markdown_usage_style.md b/doc/contributing/style_guides/markdown_usage_style.md
index 2df274a..4931ed0 100644
--- a/doc/contributing/style_guides/markdown_usage_style.md
+++ b/doc/contributing/style_guides/markdown_usage_style.md
@@ -1,6 +1,4 @@
----
-title: "Markdown Usage and Style Guide"
----
+# Markdown Usage and Style Guide
## Basics
diff --git a/doc/contributing/style_guides/otbn_style_guide.md b/doc/contributing/style_guides/otbn_style_guide.md
index 3f133e2..8a6d12c 100644
--- a/doc/contributing/style_guides/otbn_style_guide.md
+++ b/doc/contributing/style_guides/otbn_style_guide.md
@@ -1,6 +1,4 @@
----
-title: "OTBN Assembly Style Guide"
----
+# OTBN Assembly Style Guide
Where possible, OTBN assembly should follow the same principles as the [RISC-V assembly style guide](./asm_coding_style.md).
This guide describes additional OTBN-specific guidelines, and places where OTBN assembly can or should diverge from the RISC-V style guidelines.
diff --git a/doc/contributing/style_guides/python_coding_style.md b/doc/contributing/style_guides/python_coding_style.md
index e294459..15dda01 100644
--- a/doc/contributing/style_guides/python_coding_style.md
+++ b/doc/contributing/style_guides/python_coding_style.md
@@ -1,6 +1,4 @@
----
-title: "Python Coding Style Guide"
----
+# Python Coding Style Guide
## Basics
diff --git a/doc/contributing/sw/device_interface_functions.md b/doc/contributing/sw/device_interface_functions.md
index 8f5eb4c..45ecddf 100644
--- a/doc/contributing/sw/device_interface_functions.md
+++ b/doc/contributing/sw/device_interface_functions.md
@@ -1,6 +1,4 @@
----
-title: "Device Interface Functions (DIFs)"
----
+# Device Interface Functions (DIFs)
## Motivation
diff --git a/doc/contributing/sw/otbn_sw.md b/doc/contributing/sw/otbn_sw.md
index 6640d39..cf17e5a 100644
--- a/doc/contributing/sw/otbn_sw.md
+++ b/doc/contributing/sw/otbn_sw.md
@@ -1,6 +1,4 @@
----
-title: "Writing and building software for OTBN"
----
+# Writing and building software for OTBN
OTBN is the OpenTitan Big Number accelerator and this document describes how to write and build software for it.
The [OTBN reference manual](../../../hw/ip/otbn/README.md) describes the hardware and associated ISA.
diff --git a/doc/contributing/system_list.md b/doc/contributing/system_list.md
index 9744c85..27c2d9a 100644
--- a/doc/contributing/system_list.md
+++ b/doc/contributing/system_list.md
@@ -1,6 +1,4 @@
----
-title: "List of Top-Level Designs"
----
+# List of Top-Level Designs
This page lists all top-level designs and their targets that are contained within this repository.
Click on the design name to get more information about the design.
diff --git a/doc/guides/getting_started/src/README.md b/doc/guides/getting_started/src/README.md
index 5fb9b8b..77f90aa 100644
--- a/doc/guides/getting_started/src/README.md
+++ b/doc/guides/getting_started/src/README.md
@@ -1,9 +1,4 @@
----
-title: "Getting Started"
-aliases:
- - /doc/ug/getting_started
- - /doc/ug/install_instructions
----
+# Getting Started
Welcome!
This guide will help you get OpenTitan up and running.
diff --git a/doc/guides/getting_started/src/build_docs.md b/doc/guides/getting_started/src/build_docs.md
index 7a16260..b882d0d 100644
--- a/doc/guides/getting_started/src/build_docs.md
+++ b/doc/guides/getting_started/src/build_docs.md
@@ -1,6 +1,4 @@
----
-title: "Building documentation"
----
+# Building documentation
The documentation for OpenTitan is available [online](https://docs.opentitan.org).
The creation of documentation is mainly based around the conversion from Markdown to HTML files with [Hugo](https://gohugo.io/).
diff --git a/doc/guides/getting_started/src/build_sw.md b/doc/guides/getting_started/src/build_sw.md
index 0fb2a48..510b96a 100644
--- a/doc/guides/getting_started/src/build_sw.md
+++ b/doc/guides/getting_started/src/build_sw.md
@@ -1,8 +1,4 @@
----
-title: Building (and Testing) Software
-aliases:
- - /doc/ug/getting_started_build_sw
----
+# Building (and Testing) Software
_Before following this guide, make sure you have read the_:
* main [Getting Started](README.md) instructions,
diff --git a/doc/guides/getting_started/src/install_openocd.md b/doc/guides/getting_started/src/install_openocd.md
index 4a08594..0a2e2e1 100644
--- a/doc/guides/getting_started/src/install_openocd.md
+++ b/doc/guides/getting_started/src/install_openocd.md
@@ -1,6 +1,4 @@
----
-title: Install OpenOCD
----
+# Install OpenOCD
OpenOCD is a tool to connect with the target chip over JTAG and similar transports.
It also provides a GDB server which is an "intermediate" when debugging software on the chip with GDB.
diff --git a/doc/guides/getting_started/src/install_vivado/README.md b/doc/guides/getting_started/src/install_vivado/README.md
index e1a14e4..db7ed0d 100644
--- a/doc/guides/getting_started/src/install_vivado/README.md
+++ b/doc/guides/getting_started/src/install_vivado/README.md
@@ -1,6 +1,4 @@
----
-title: Install Vivado
----
+# Install Vivado
Generating a bitstream for Xilinx devices requires a
[Vivado](https://www.xilinx.com/products/design-tools/vivado.html) installation.
diff --git a/doc/guides/getting_started/src/setup_dv.md b/doc/guides/getting_started/src/setup_dv.md
index 354335a..2bc0314 100644
--- a/doc/guides/getting_started/src/setup_dv.md
+++ b/doc/guides/getting_started/src/setup_dv.md
@@ -1,8 +1,4 @@
----
-title: "Design Verification Setup"
-aliases:
- - /doc/ug/getting_started_dv
----
+# Design Verification Setup
_Before following this guide, make sure you've followed the [dependency installation and software build instructions](https://opentitan.org/book/doc/guides/getting_started/)._
diff --git a/doc/guides/getting_started/src/setup_formal.md b/doc/guides/getting_started/src/setup_formal.md
index c14d7d1..d9b7c57 100644
--- a/doc/guides/getting_started/src/setup_formal.md
+++ b/doc/guides/getting_started/src/setup_formal.md
@@ -1,8 +1,4 @@
----
-title: "Formal Verification Setup"
-aliases:
- - /doc/ug/getting_started_formal
----
+# Formal Verification Setup
_Before following this guide, make sure you've followed the [dependency installation and software build instructions](README.md)._
diff --git a/doc/guides/getting_started/src/setup_fpga.md b/doc/guides/getting_started/src/setup_fpga.md
index c55f1e3..5d6d113 100644
--- a/doc/guides/getting_started/src/setup_fpga.md
+++ b/doc/guides/getting_started/src/setup_fpga.md
@@ -1,8 +1,4 @@
----
-title: "FPGA Setup"
-aliases:
- - /doc/ug/getting_started_fpga
----
+# FPGA Setup
_Before following this guide, make sure you've followed the [dependency installation and software build instructions](README.md)._
diff --git a/doc/guides/getting_started/src/setup_verilator.md b/doc/guides/getting_started/src/setup_verilator.md
index 91291f2..bc0368c 100644
--- a/doc/guides/getting_started/src/setup_verilator.md
+++ b/doc/guides/getting_started/src/setup_verilator.md
@@ -1,8 +1,4 @@
----
-title: Verilator Setup
-aliases:
- - /doc/ug/getting_started_verilator
----
+# Verilator Setup
_Before following this guide, make sure you've followed the [dependency installation instructions](README.md)._
diff --git a/doc/introduction.md b/doc/introduction.md
index 24ec2fc..a82a16b 100644
--- a/doc/introduction.md
+++ b/doc/introduction.md
@@ -1,6 +1,4 @@
----
-title: "OpenTitan"
----
+# OpenTitan
## Introduction to OpenTitan
diff --git a/doc/project_governance/README.md b/doc/project_governance/README.md
index 4ef2acc..5c0ac23 100644
--- a/doc/project_governance/README.md
+++ b/doc/project_governance/README.md
@@ -1,6 +1,4 @@
----
-title: "Introduction to the OpenTitan Project"
----
+# Introduction to the OpenTitan Project
OpenTitan is a collaborative hardware and software development program with contributors from many organizations.
This area gives some more information about how the project itself is organized and how to contribute.
diff --git a/doc/project_governance/checklist/README.md b/doc/project_governance/checklist/README.md
index d2fb80e..a45a9ba 100644
--- a/doc/project_governance/checklist/README.md
+++ b/doc/project_governance/checklist/README.md
@@ -1,6 +1,4 @@
----
-title: "Signoff Checklist"
----
+# Signoff Checklist
This document explains the recommended checklist items to review when transitioning from one [Development Stage](../development_stages.md) to another, for design, verification, and [software device interface function (DIF)](../../contributing/sw/device_interface_functions.md) stages.
It is expected that the items in each stage (D1, V1, S1, etc) are completed.
diff --git a/doc/project_governance/committers.md b/doc/project_governance/committers.md
index ffee7b5..658cd15 100644
--- a/doc/project_governance/committers.md
+++ b/doc/project_governance/committers.md
@@ -1,6 +1,4 @@
----
-title: "Committers"
----
+# Committers
Committers are individuals with repository write access.
While everyone can and is encouraged to contribute by reviewing code, committers are responsible for final approval and merge.
diff --git a/doc/project_governance/development_stages.md b/doc/project_governance/development_stages.md
index 01d4ad5..0b99c8e 100644
--- a/doc/project_governance/development_stages.md
+++ b/doc/project_governance/development_stages.md
@@ -1,7 +1,4 @@
----
-aliases: [/doc/project/hw_stages/]
-title: OpenTitan Hardware Development Stages
----
+# OpenTitan Hardware Development Stages
## Document Goals
diff --git a/doc/project_governance/rfc_process.md b/doc/project_governance/rfc_process.md
index 168c4b8..7071300 100644
--- a/doc/project_governance/rfc_process.md
+++ b/doc/project_governance/rfc_process.md
@@ -1,6 +1,4 @@
----
-title: OpenTitan RFC Process
----
+# OpenTitan RFC Process
## Introduction
diff --git a/doc/project_governance/technical_committee.md b/doc/project_governance/technical_committee.md
index 1a5ea9d..ab70209 100644
--- a/doc/project_governance/technical_committee.md
+++ b/doc/project_governance/technical_committee.md
@@ -1,6 +1,4 @@
----
-title: "OpenTitan Technical Committee"
----
+# OpenTitan Technical Committee
The OpenTitan Technical Committee is part of the [OpenTitan governance structure](./README.md) and the definitive description of its operations and responsibilities are stated in the [OpenTitan Technical Charter](https://static.opentitan.org/technical-charter.pdf).
Key responsibilities defined in that document include:
diff --git a/doc/rust_for_c_devs.md b/doc/rust_for_c_devs.md
index c8c5acd..6450f18 100644
--- a/doc/rust_for_c_devs.md
+++ b/doc/rust_for_c_devs.md
@@ -1,6 +1,4 @@
----
-title: "Rust for Embedded C Programmers"
----
+# Rust for Embedded C Programmers
## Foreword
diff --git a/doc/security/README.md b/doc/security/README.md
index 1584bb6..3bcd51a 100644
--- a/doc/security/README.md
+++ b/doc/security/README.md
@@ -1,7 +1,4 @@
----
-title: "Security"
-url: "/security/"
----
+# Security
## Overview
diff --git a/doc/security/implementation_guidelines/README.md b/doc/security/implementation_guidelines/README.md
index ca03df7..db2af7f 100644
--- a/doc/security/implementation_guidelines/README.md
+++ b/doc/security/implementation_guidelines/README.md
@@ -1,5 +1,3 @@
----
-title: Implementation Guidelines
----
+# Implementation Guidelines
{{% sectionContent %}}
diff --git a/doc/security/implementation_guidelines/hardware/README.md b/doc/security/implementation_guidelines/hardware/README.md
index 6130ae7..96a49b7 100644
--- a/doc/security/implementation_guidelines/hardware/README.md
+++ b/doc/security/implementation_guidelines/hardware/README.md
@@ -1,6 +1,4 @@
----
-title: "Secure Hardware Design Guidelines"
----
+# Secure Hardware Design Guidelines
## Overview
diff --git a/doc/security/logical_security_model/README.md b/doc/security/logical_security_model/README.md
index 09086f8..e01c3d4 100644
--- a/doc/security/logical_security_model/README.md
+++ b/doc/security/logical_security_model/README.md
@@ -1,6 +1,4 @@
----
-title: "OpenTitan Logical Security Model"
----
+# OpenTitan Logical Security Model
## Overview
diff --git a/doc/security/specs/README.md b/doc/security/specs/README.md
index 105ecfe..f45f583 100644
--- a/doc/security/specs/README.md
+++ b/doc/security/specs/README.md
@@ -1,6 +1,4 @@
----
-title: "OpenTitan Security Model Specification"
----
+# OpenTitan Security Model Specification
The current version of the security model targets discrete silicon
implementations of OpenTitan. The architecture for an integrated IP solution
diff --git a/doc/security/specs/attestation/README.md b/doc/security/specs/attestation/README.md
index e8a184d..fe6468d 100644
--- a/doc/security/specs/attestation/README.md
+++ b/doc/security/specs/attestation/README.md
@@ -1,6 +1,4 @@
----
-title: "Device Attestation"
----
+# Device Attestation
## Overview
diff --git a/doc/security/specs/device_life_cycle/README.md b/doc/security/specs/device_life_cycle/README.md
index 4279920..9634672 100644
--- a/doc/security/specs/device_life_cycle/README.md
+++ b/doc/security/specs/device_life_cycle/README.md
@@ -1,6 +1,4 @@
----
-title: "Device Life Cycle"
----
+# Device Life Cycle
## Overview
diff --git a/doc/security/specs/device_provisioning/README.md b/doc/security/specs/device_provisioning/README.md
index 09bc725..a84e856 100644
--- a/doc/security/specs/device_provisioning/README.md
+++ b/doc/security/specs/device_provisioning/README.md
@@ -1,6 +1,4 @@
----
-title: "Device Provisioning"
----
+# Device Provisioning
<p style="color: red; text-align: right;">
Status: Pre-RFC
diff --git a/doc/security/specs/firmware_update/README.md b/doc/security/specs/firmware_update/README.md
index 562e84b..80dbc29 100644
--- a/doc/security/specs/firmware_update/README.md
+++ b/doc/security/specs/firmware_update/README.md
@@ -1,6 +1,4 @@
----
-title: "Firmware Update"
----
+# Firmware Update
<p style="color: red; text-align: right;">
Status: Pre-RFC
diff --git a/doc/security/specs/identities_and_root_keys/README.md b/doc/security/specs/identities_and_root_keys/README.md
index 18cc688..054dec9 100644
--- a/doc/security/specs/identities_and_root_keys/README.md
+++ b/doc/security/specs/identities_and_root_keys/README.md
@@ -1,6 +1,4 @@
----
-title: "Identities and Root Keys"
----
+# Identities and Root Keys
## Overview
diff --git a/doc/security/specs/ownership_transfer/README.md b/doc/security/specs/ownership_transfer/README.md
index 5d2c349..9f33e57 100644
--- a/doc/security/specs/ownership_transfer/README.md
+++ b/doc/security/specs/ownership_transfer/README.md
@@ -1,6 +1,4 @@
----
-title: "Ownership Transfer"
----
+# Ownership Transfer
## Overview
diff --git a/doc/security/specs/secure_boot/README.md b/doc/security/specs/secure_boot/README.md
index 372493f..012025b 100644
--- a/doc/security/specs/secure_boot/README.md
+++ b/doc/security/specs/secure_boot/README.md
@@ -1,6 +1,4 @@
----
-title: "Secure Boot"
----
+# Secure Boot
<p style="color: red; text-align: right;">
Status: Pre-RFC
diff --git a/doc/security/threat_model/README.md b/doc/security/threat_model/README.md
index 8c2b0a6..d4dbc27 100644
--- a/doc/security/threat_model/README.md
+++ b/doc/security/threat_model/README.md
@@ -1,6 +1,4 @@
----
-title: Lightweight Threat Model
----
+# Lightweight Threat Model
This threat model aims to identify in-scope design assets, attacker profiles,
attack methods and attack surfaces. This is used to produce security
diff --git a/doc/use_cases/README.md b/doc/use_cases/README.md
index 56f2016..7995087 100644
--- a/doc/use_cases/README.md
+++ b/doc/use_cases/README.md
@@ -1,6 +1,4 @@
----
-title: "Use Cases"
----
+# Use Cases
## Overview
diff --git a/doc/use_cases/platform_integrity_module/README.md b/doc/use_cases/platform_integrity_module/README.md
index 630078d..385076b 100644
--- a/doc/use_cases/platform_integrity_module/README.md
+++ b/doc/use_cases/platform_integrity_module/README.md
@@ -1,6 +1,4 @@
----
-title: "Platform Integrity Module"
----
+# Platform Integrity Module
An OpenTitan IC used as a Platform Integrity Module interposes between a
platform's boot flash and its main boot devices such as the Baseboard Management
diff --git a/doc/use_cases/tpm/README.md b/doc/use_cases/tpm/README.md
index c2ccb4a..ada6a78 100644
--- a/doc/use_cases/tpm/README.md
+++ b/doc/use_cases/tpm/README.md
@@ -1,6 +1,4 @@
----
-title: "Trusted Platform Module - TPM"
----
+# Trusted Platform Module - TPM
## Overview
diff --git a/doc/use_cases/u2f/README.md b/doc/use_cases/u2f/README.md
index eb2eb2d..ad471ed 100644
--- a/doc/use_cases/u2f/README.md
+++ b/doc/use_cases/u2f/README.md
@@ -1,6 +1,4 @@
----
-title: "Universal 2nd-Factor Security Key"
----
+# Universal 2nd-Factor Security Key
When used as a security key, OpenTitan implements the Universal 2nd Factor (U2F)
authentication standard, using a Universal Serial Bus (USB) 1.1 interface to
diff --git a/hw/README.md b/hw/README.md
index fed27c9..a5336f2 100644
--- a/hw/README.md
+++ b/hw/README.md
@@ -1,7 +1,4 @@
----
-title: "Hardware"
-aliases: [/doc/project/hw_dashboard/]
----
+# Hardware
This page serves as the landing spot for all hardware development within the OpenTitan project.
diff --git a/hw/dv/README.md b/hw/dv/README.md
index 7a363f1..10af998 100644
--- a/hw/dv/README.md
+++ b/hw/dv/README.md
@@ -1,6 +1,4 @@
----
-title: "Common Design Verification Collateral"
----
+# Common Design Verification Collateral
The documentation is split into SystemVerilog reference and tools.
{{% sectionContent type="section" depth="1" %}}
diff --git a/hw/dv/doc/dv_doc_template.md b/hw/dv/doc/dv_doc_template.md
index 24aabd8..e5ce44c 100644
--- a/hw/dv/doc/dv_doc_template.md
+++ b/hw/dv/doc/dv_doc_template.md
@@ -1,7 +1,4 @@
----
-title: "FOO DV document"
-draft: true
----
+# FOO DV document
<!-- Copy this file to hw/ip/foo/doc/index.md and make changes as needed.
For convenience 'foo' in the document can be searched and replaced easily with the
diff --git a/hw/dv/sv/README.md b/hw/dv/sv/README.md
index 2760a01..e2dc2c6 100644
--- a/hw/dv/sv/README.md
+++ b/hw/dv/sv/README.md
@@ -1,6 +1,4 @@
----
-title: "Common SystemVerilog and UVM Components"
----
+# Common SystemVerilog and UVM Components
## Content
{{% sectionContent %}}
diff --git a/hw/dv/sv/alert_esc_agent/README.md b/hw/dv/sv/alert_esc_agent/README.md
index 7596480..19b9146 100644
--- a/hw/dv/sv/alert_esc_agent/README.md
+++ b/hw/dv/sv/alert_esc_agent/README.md
@@ -1,6 +1,4 @@
----
-title: "ALERT_ESC Agent"
----
+# ALERT_ESC Agent
ALERT_ESC UVM Agent is extended from DV library agent classes.
diff --git a/hw/dv/sv/bus_params_pkg/README.md b/hw/dv/sv/bus_params_pkg/README.md
index 95d7484..826f934 100644
--- a/hw/dv/sv/bus_params_pkg/README.md
+++ b/hw/dv/sv/bus_params_pkg/README.md
@@ -1,6 +1,4 @@
----
-title: "bus_params_pkg"
----
+# bus_params_pkg
This package provides an isolation for all common verification components under
`hw/dv/sv/` from the OpenTitan specific design constants provided in
diff --git a/hw/dv/sv/cip_lib/README.md b/hw/dv/sv/cip_lib/README.md
index 64db316..3b7bd7a 100644
--- a/hw/dv/sv/cip_lib/README.md
+++ b/hw/dv/sv/cip_lib/README.md
@@ -1,6 +1,4 @@
----
-title: Comportable IP Testbench Architecture
----
+# Comportable IP Testbench Architecture
## Overview
Going along the lines of what it takes to design an IP that adheres to the
diff --git a/hw/dv/sv/common_ifs/README.md b/hw/dv/sv/common_ifs/README.md
index 5308b2f..54124d2 100644
--- a/hw/dv/sv/common_ifs/README.md
+++ b/hw/dv/sv/common_ifs/README.md
@@ -1,6 +1,4 @@
----
-title: Common Interfaces
----
+# Common Interfaces
## Overview
In this directory, we provide commonly used interfaces used to construct
diff --git a/hw/dv/sv/csr_utils/README.md b/hw/dv/sv/csr_utils/README.md
index 60e1256..2652d90 100644
--- a/hw/dv/sv/csr_utils/README.md
+++ b/hw/dv/sv/csr_utils/README.md
@@ -1,6 +1,4 @@
----
-title: "CSR utilities"
----
+# CSR utilities
This csr_utils folder intends to implement CSR related methods and test sequences for DV
to share across all testbenches.
diff --git a/hw/dv/sv/csrng_agent/README.md b/hw/dv/sv/csrng_agent/README.md
index 84fd750..2baca95 100644
--- a/hw/dv/sv/csrng_agent/README.md
+++ b/hw/dv/sv/csrng_agent/README.md
@@ -1,6 +1,4 @@
----
-title: "CSRNG UVM Agent"
----
+# CSRNG UVM Agent
CSRNG UVM Agent is extended from DV library agent classes.
Models host or device csrng functionality.
diff --git a/hw/dv/sv/dv_lib/README.md b/hw/dv/sv/dv_lib/README.md
index 96fe0cf..9a61b3c 100644
--- a/hw/dv/sv/dv_lib/README.md
+++ b/hw/dv/sv/dv_lib/README.md
@@ -1,6 +1,4 @@
----
-title: "DV Library Classes"
----
+# DV Library Classes
# DV library classes
diff --git a/hw/dv/sv/flash_phy_prim_agent/README.md b/hw/dv/sv/flash_phy_prim_agent/README.md
index ab465b4..593f09b 100644
--- a/hw/dv/sv/flash_phy_prim_agent/README.md
+++ b/hw/dv/sv/flash_phy_prim_agent/README.md
@@ -1,5 +1,3 @@
----
-title: Flash Phy Primitive UVM Agent
----
+# Flash Phy Primitive UVM Agent
FLASH_PHY_PRIM UVM Agent is extended from DV library agent classes.
diff --git a/hw/dv/sv/i2c_agent/README.md b/hw/dv/sv/i2c_agent/README.md
index 5da5bcf..39a8780 100644
--- a/hw/dv/sv/i2c_agent/README.md
+++ b/hw/dv/sv/i2c_agent/README.md
@@ -1,5 +1,3 @@
----
-title: "I2C DV UVM Agent"
----
+# I2C DV UVM Agent
I2C UVM Agent is extended from DV library agent classes.
diff --git a/hw/dv/sv/jtag_agent/README.md b/hw/dv/sv/jtag_agent/README.md
index 6b6d2d0..6bed9e9 100644
--- a/hw/dv/sv/jtag_agent/README.md
+++ b/hw/dv/sv/jtag_agent/README.md
@@ -1,6 +1,4 @@
----
-title: "JTAG DV UVM Agent"
----
+# JTAG DV UVM Agent
JTAG UVM Agent is extended from the
[DV library agent](../dv_lib/README.md) classes, which
diff --git a/hw/dv/sv/jtag_dmi_agent/README.md b/hw/dv/sv/jtag_dmi_agent/README.md
index 6913896..f664526 100644
--- a/hw/dv/sv/jtag_dmi_agent/README.md
+++ b/hw/dv/sv/jtag_dmi_agent/README.md
@@ -1,6 +1,4 @@
----
-title: JTAG_DMI UVM Agent
----
+# JTAG_DMI UVM Agent
JTAG_DMI UVM Agent is extended from DV library agent classes. Contrary to what
the name suggests, it actually does not come with an agent. It is called an
diff --git a/hw/dv/sv/jtag_riscv_agent/README.md b/hw/dv/sv/jtag_riscv_agent/README.md
index 574ebe3..67abe44 100644
--- a/hw/dv/sv/jtag_riscv_agent/README.md
+++ b/hw/dv/sv/jtag_riscv_agent/README.md
@@ -1,6 +1,4 @@
----
-title: "JTAG RISCV DV UVM Agent"
----
+# JTAG RISCV DV UVM Agent
JTAG RISCV UVM Agent is extended from DV library agent classes.
This is a high-level agent that builds on top of the JTAG agent.
diff --git a/hw/dv/sv/key_sideload_agent/README.md b/hw/dv/sv/key_sideload_agent/README.md
index c6fca08..35361db 100644
--- a/hw/dv/sv/key_sideload_agent/README.md
+++ b/hw/dv/sv/key_sideload_agent/README.md
@@ -1,5 +1,3 @@
----
-title: "KEY_SIDELOAD UVM Agent"
----
+# KEY_SIDELOAD UVM Agent
KEY_SIDELOAD UVM Agent is extended from DV library agent classes.
diff --git a/hw/dv/sv/kmac_app_agent/README.md b/hw/dv/sv/kmac_app_agent/README.md
index 4f6ddd5..85ea2c2 100644
--- a/hw/dv/sv/kmac_app_agent/README.md
+++ b/hw/dv/sv/kmac_app_agent/README.md
@@ -1,5 +1,3 @@
----
-title: "KMAC_APP UVM Agent"
----
+# KMAC_APP UVM Agent
KMAC_APP UVM Agent is extended from DV library agent classes.
diff --git a/hw/dv/sv/mem_bkdr_scb/README.md b/hw/dv/sv/mem_bkdr_scb/README.md
index 2b3688a..6577972 100644
--- a/hw/dv/sv/mem_bkdr_scb/README.md
+++ b/hw/dv/sv/mem_bkdr_scb/README.md
@@ -1,6 +1,4 @@
----
-title: "Memory Backdoor Scoreboard"
----
+# Memory Backdoor Scoreboard
The mem_model_pkg checks write value matches with previous write value, but
there are some limitations.
diff --git a/hw/dv/sv/mem_bkdr_util/README.md b/hw/dv/sv/mem_bkdr_util/README.md
index b7ab950..51a1d10 100644
--- a/hw/dv/sv/mem_bkdr_util/README.md
+++ b/hw/dv/sv/mem_bkdr_util/README.md
@@ -1,6 +1,4 @@
----
-title: "Memory Backdoor Utility Class"
----
+# Memory Backdoor Utility Class
The `mem_bkdr_util` class provides a way to manipulate the memory array directly via backdoor.
It includes a set of functions to backdoor read or write any address location within the memory.
diff --git a/hw/dv/sv/mem_model/README.md b/hw/dv/sv/mem_model/README.md
index 59c1055..68d0f6f 100644
--- a/hw/dv/sv/mem_model/README.md
+++ b/hw/dv/sv/mem_model/README.md
@@ -1,6 +1,4 @@
----
-title: "Memory Model"
----
+# Memory Model
The memory model UVC models a memory device which any host interface can read
from or write to. It is implemented as a `uvm_object`, and instantiates an
diff --git a/hw/dv/sv/pattgen_agent/README.md b/hw/dv/sv/pattgen_agent/README.md
index ded3041..6879de3 100644
--- a/hw/dv/sv/pattgen_agent/README.md
+++ b/hw/dv/sv/pattgen_agent/README.md
@@ -1,5 +1,3 @@
----
-title: "PATTGEN UVM Agent"
----
+# PATTGEN UVM Agent
PATTGEN UVM Agent is extended from DV library agent classes.
diff --git a/hw/dv/sv/push_pull_agent/README.md b/hw/dv/sv/push_pull_agent/README.md
index b7cda25..839deb8 100644
--- a/hw/dv/sv/push_pull_agent/README.md
+++ b/hw/dv/sv/push_pull_agent/README.md
@@ -1,6 +1,4 @@
----
-title: "PUSH_PULL UVM Agent"
----
+# PUSH_PULL UVM Agent
PUSH_PULL UVM Agent is extended from DV library agent classes.
diff --git a/hw/dv/sv/pwm_monitor/README.md b/hw/dv/sv/pwm_monitor/README.md
index 9f2aba1..aa4b4a8 100644
--- a/hw/dv/sv/pwm_monitor/README.md
+++ b/hw/dv/sv/pwm_monitor/README.md
@@ -1,5 +1,3 @@
----
-title: "PWM UVM Monitor"
----
+# PWM UVM Monitor
PWM UVM Monitor is extended from DV library agent classes.
diff --git a/hw/dv/sv/rng_agent/README.md b/hw/dv/sv/rng_agent/README.md
index 17934ea..42667cf 100644
--- a/hw/dv/sv/rng_agent/README.md
+++ b/hw/dv/sv/rng_agent/README.md
@@ -1,6 +1,4 @@
----
-title: "RNG UVM Agent"
----
+# RNG UVM Agent
RNG UVM Agent is extended from DV library agent classes.
diff --git a/hw/dv/sv/scoreboard/README.md b/hw/dv/sv/scoreboard/README.md
index 3ea7e29..ce9da37 100644
--- a/hw/dv/sv/scoreboard/README.md
+++ b/hw/dv/sv/scoreboard/README.md
@@ -1,5 +1,3 @@
----
-title: "Scoreboard"
----
+# Scoreboard
**TODO**
diff --git a/hw/dv/sv/sim_sram/README.md b/hw/dv/sv/sim_sram/README.md
index d39bcbc..b936539 100644
--- a/hw/dv/sv/sim_sram/README.md
+++ b/hw/dv/sv/sim_sram/README.md
@@ -1,6 +1,4 @@
----
-title: "Simulation SRAM"
----
+# Simulation SRAM
The `sim_sram` module intercepts an outbound TL interface to carve out a chunk of "fake" memory used for simulation purposes only.
This chunk of memory must not overlap with any device on the system address map - it must be an invalid address range from the system's perspective.
diff --git a/hw/dv/sv/spi_agent/README.md b/hw/dv/sv/spi_agent/README.md
index 30e7899..4c82f45 100644
--- a/hw/dv/sv/spi_agent/README.md
+++ b/hw/dv/sv/spi_agent/README.md
@@ -1,5 +1,3 @@
----
-title: "SPI UVM Agent"
----
+# SPI UVM Agent
SPI UVM Agent is extended from DV library agent classes.
diff --git a/hw/dv/sv/str_utils/README.md b/hw/dv/sv/str_utils/README.md
index ea2fbff..b13afd1 100644
--- a/hw/dv/sv/str_utils/README.md
+++ b/hw/dv/sv/str_utils/README.md
@@ -1,6 +1,4 @@
----
-title: "str_utils_pkg"
----
+# str_utils_pkg
This package provides some basic string and path manipulation utility functions that
can be used across the project. It can be imported in non-UVM testbenches as
diff --git a/hw/dv/sv/test_vectors/README.md b/hw/dv/sv/test_vectors/README.md
index d92380c..eb40626 100644
--- a/hw/dv/sv/test_vectors/README.md
+++ b/hw/dv/sv/test_vectors/README.md
@@ -1,6 +1,4 @@
----
-title: "Test Vectors"
----
+# Test Vectors
## test_vectors_pkg.sv
This class read a list of vector files and parse the useful information to
diff --git a/hw/dv/sv/tl_agent/README.md b/hw/dv/sv/tl_agent/README.md
index beb42ee..844d014 100644
--- a/hw/dv/sv/tl_agent/README.md
+++ b/hw/dv/sv/tl_agent/README.md
@@ -1,5 +1,3 @@
----
-title: "TileLink UVM Agent"
----
+# TileLink UVM Agent
**TODO**
diff --git a/hw/dv/sv/uart_agent/README.md b/hw/dv/sv/uart_agent/README.md
index cc3a3e3..e39fe4a 100644
--- a/hw/dv/sv/uart_agent/README.md
+++ b/hw/dv/sv/uart_agent/README.md
@@ -1,5 +1,3 @@
----
-title: "UART Agent"
----
+# UART Agent
**TODO**
diff --git a/hw/dv/sv/usb20_agent/README.md b/hw/dv/sv/usb20_agent/README.md
index e88ecfc..d2f75a4 100644
--- a/hw/dv/sv/usb20_agent/README.md
+++ b/hw/dv/sv/usb20_agent/README.md
@@ -1,6 +1,4 @@
----
-title: "USB20 UVM Agent"
----
+# USB20 UVM Agent
USB20 UVM Agent is extended from DV library agent classes. This is just a
skeleton implementation for now. There is no functionality available yet.
diff --git a/hw/dv/tools/README.md b/hw/dv/tools/README.md
index 90d97c5..cf7dc84 100644
--- a/hw/dv/tools/README.md
+++ b/hw/dv/tools/README.md
@@ -1,5 +1,3 @@
----
-title: "Tools"
----
+# Tools
{{% sectionContent %}}
diff --git a/hw/dv/tools/ralgen/README.md b/hw/dv/tools/ralgen/README.md
index 2d833b4..1edbb94 100644
--- a/hw/dv/tools/ralgen/README.md
+++ b/hw/dv/tools/ralgen/README.md
@@ -1,6 +1,4 @@
----
-title: "`ralgen`: A FuseSoC generator for UVM RAL package"
----
+# `ralgen`: A FuseSoC generator for UVM RAL package
The `ralgen.py` script is implemented as a
[FuseSoC generator](https://fusesoc.readthedocs.io/en/master/user/generators.html).
diff --git a/hw/formal/README.md b/hw/formal/README.md
index 58726fb..032111b 100644
--- a/hw/formal/README.md
+++ b/hw/formal/README.md
@@ -1,7 +1,4 @@
----
-title: "OpenTitan Assertions"
-unlisted: true
----
+# OpenTitan Assertions
# OpenTitan Assertions
diff --git a/hw/ip/README.md b/hw/ip/README.md
index ad34257..5ea7d6d 100644
--- a/hw/ip/README.md
+++ b/hw/ip/README.md
@@ -1,5 +1,3 @@
----
-title: "IP cores"
----
+# IP cores
{{% sectionContent type="section" depth="1" %}}
diff --git a/hw/ip/adc_ctrl/README.md b/hw/ip/adc_ctrl/README.md
index 6e4938d..aff9d8a 100644
--- a/hw/ip/adc_ctrl/README.md
+++ b/hw/ip/adc_ctrl/README.md
@@ -1,6 +1,4 @@
----
-title: "Analog to Digital Converter Control Interface"
----
+# Analog to Digital Converter Control Interface
# Overview
diff --git a/hw/ip/adc_ctrl/doc/checklist.md b/hw/ip/adc_ctrl/doc/checklist.md
index 330314f..00ebfce 100644
--- a/hw/ip/adc_ctrl/doc/checklist.md
+++ b/hw/ip/adc_ctrl/doc/checklist.md
@@ -1,6 +1,4 @@
----
-title: "ADC_CTRL Checklist"
----
+# ADC_CTRL Checklist
<!--
NOTE: This is a template checklist document that is required to be copied over to the 'doc'
diff --git a/hw/ip/adc_ctrl/dv/README.md b/hw/ip/adc_ctrl/dv/README.md
index 8936421..376b677 100644
--- a/hw/ip/adc_ctrl/dv/README.md
+++ b/hw/ip/adc_ctrl/dv/README.md
@@ -1,6 +1,4 @@
----
-title: "ADC_CTRL DV document"
----
+# ADC_CTRL DV document
## Goals
* **DV**
diff --git a/hw/ip/aes/README.md b/hw/ip/aes/README.md
index 84e53c2..798e32e 100644
--- a/hw/ip/aes/README.md
+++ b/hw/ip/aes/README.md
@@ -1,6 +1,4 @@
----
-title: "AES HWIP Technical Specification"
----
+# AES HWIP Technical Specification
# Overview
diff --git a/hw/ip/aes/doc/checklist.md b/hw/ip/aes/doc/checklist.md
index 7af1138..c97ad99 100644
--- a/hw/ip/aes/doc/checklist.md
+++ b/hw/ip/aes/doc/checklist.md
@@ -1,6 +1,4 @@
----
-title: "AES Checklist"
----
+# AES Checklist
This checklist is for [Hardware Stage](../../../../doc/project_governance/development_stages.md) transitions for the [AES peripheral.](../README.md)
All checklist items refer to the content in the [Checklist.](../../../../doc/project_governance/checklist/README.md)
diff --git a/hw/ip/aes/dv/README.md b/hw/ip/aes/dv/README.md
index d276bb9..f09b85a 100644
--- a/hw/ip/aes/dv/README.md
+++ b/hw/ip/aes/dv/README.md
@@ -1,6 +1,4 @@
----
-title: "AES DV document"
----
+# AES DV document
## Goals
* **DV**
diff --git a/hw/ip/aon_timer/README.md b/hw/ip/aon_timer/README.md
index 704898d..5f84d17 100644
--- a/hw/ip/aon_timer/README.md
+++ b/hw/ip/aon_timer/README.md
@@ -1,6 +1,4 @@
----
-title: "AON Timer Technical Specification"
----
+# AON Timer Technical Specification
# Overview
diff --git a/hw/ip/aon_timer/doc/checklist.md b/hw/ip/aon_timer/doc/checklist.md
index 1e23e62..eaaeab0 100644
--- a/hw/ip/aon_timer/doc/checklist.md
+++ b/hw/ip/aon_timer/doc/checklist.md
@@ -1,6 +1,4 @@
----
-title: "AON Timer Checklist"
----
+# AON Timer Checklist
This checklist is for [Hardware Stage](../../../../doc/project_governance/development_stages.md) transitions for the [AON Timer peripheral.](../README.md)
All checklist items refer to the content in the [Checklist.](../../../../doc/project_governance/checklist/README.md)
diff --git a/hw/ip/aon_timer/dv/README.md b/hw/ip/aon_timer/dv/README.md
index d56cafa..0b64dd3 100644
--- a/hw/ip/aon_timer/dv/README.md
+++ b/hw/ip/aon_timer/dv/README.md
@@ -1,6 +1,4 @@
----
-title: "AON Timer DV Document"
----
+# AON Timer DV Document
## Goals
* **DV**
diff --git a/hw/ip/clkmgr/README.md b/hw/ip/clkmgr/README.md
index eda0a5c..0be9f13 100644
--- a/hw/ip/clkmgr/README.md
+++ b/hw/ip/clkmgr/README.md
@@ -1,6 +1,4 @@
----
-title: "Clock Manager HWIP Technical Specification"
----
+# Clock Manager HWIP Technical Specification
# Overview
diff --git a/hw/ip/clkmgr/doc/checklist.md b/hw/ip/clkmgr/doc/checklist.md
index f0bcfa4..c8c4a36 100644
--- a/hw/ip/clkmgr/doc/checklist.md
+++ b/hw/ip/clkmgr/doc/checklist.md
@@ -1,6 +1,4 @@
----
-title: "CLKMGR Checklist"
----
+# CLKMGR Checklist
<!--
NOTE: This is a template checklist document that is required to be copied over to the 'doc'
diff --git a/hw/ip/clkmgr/dv/README.md b/hw/ip/clkmgr/dv/README.md
index 298916a..8b97b81 100644
--- a/hw/ip/clkmgr/dv/README.md
+++ b/hw/ip/clkmgr/dv/README.md
@@ -1,6 +1,4 @@
----
-title: "CLKMGR DV document"
----
+# CLKMGR DV document
## Goals
* **DV**
diff --git a/hw/ip/csrng/README.md b/hw/ip/csrng/README.md
index f47415d..9574a60 100644
--- a/hw/ip/csrng/README.md
+++ b/hw/ip/csrng/README.md
@@ -1,6 +1,4 @@
----
-title: "CSRNG HWIP Technical Specification"
----
+# CSRNG HWIP Technical Specification
# Overview
diff --git a/hw/ip/csrng/doc/checklist.md b/hw/ip/csrng/doc/checklist.md
index d501811..de175c1 100644
--- a/hw/ip/csrng/doc/checklist.md
+++ b/hw/ip/csrng/doc/checklist.md
@@ -1,6 +1,4 @@
----
-title: "CSRNG Checklist"
----
+# CSRNG Checklist
<!--
NOTE: This is a template checklist document that is required to be copied over to the 'doc'
diff --git a/hw/ip/csrng/dv/README.md b/hw/ip/csrng/dv/README.md
index d29adf1..8b466a5 100644
--- a/hw/ip/csrng/dv/README.md
+++ b/hw/ip/csrng/dv/README.md
@@ -1,6 +1,4 @@
----
-title: "CSRNG DV document"
----
+# CSRNG DV document
## Goals
* **DV**
diff --git a/hw/ip/edn/README.md b/hw/ip/edn/README.md
index bbae574..28efd8d 100644
--- a/hw/ip/edn/README.md
+++ b/hw/ip/edn/README.md
@@ -1,6 +1,4 @@
----
-title: "EDN HWIP Technical Specification"
----
+# EDN HWIP Technical Specification
# Overview
diff --git a/hw/ip/edn/doc/checklist.md b/hw/ip/edn/doc/checklist.md
index 4b84be3..6526cf6 100644
--- a/hw/ip/edn/doc/checklist.md
+++ b/hw/ip/edn/doc/checklist.md
@@ -1,6 +1,4 @@
----
-title: "EDN Checklist"
----
+# EDN Checklist
<!--
NOTE: This is a template checklist document that is required to be copied over to the 'doc'
diff --git a/hw/ip/edn/dv/README.md b/hw/ip/edn/dv/README.md
index 37c1837..7143065 100644
--- a/hw/ip/edn/dv/README.md
+++ b/hw/ip/edn/dv/README.md
@@ -1,6 +1,4 @@
----
-title: "EDN DV document"
----
+# EDN DV document
## Goals
* **DV**
diff --git a/hw/ip/entropy_src/README.md b/hw/ip/entropy_src/README.md
index 2c85a17..bf00dbd 100644
--- a/hw/ip/entropy_src/README.md
+++ b/hw/ip/entropy_src/README.md
@@ -1,6 +1,4 @@
----
-title: "ENTROPY_SRC HWIP Technical Specification"
----
+# ENTROPY_SRC HWIP Technical Specification
# Overview
diff --git a/hw/ip/entropy_src/doc/checklist.md b/hw/ip/entropy_src/doc/checklist.md
index bee6aa9..fff0906 100644
--- a/hw/ip/entropy_src/doc/checklist.md
+++ b/hw/ip/entropy_src/doc/checklist.md
@@ -1,6 +1,4 @@
----
-title: "ENTROPY_SRC Checklist"
----
+# ENTROPY_SRC Checklist
This checklist is for [Hardware Stage](../../../../doc/project_governance/development_stages.md) transitions for the [ENTROPY_SRC peripheral.](../README.md)
All checklist items refer to the content in the [Checklist.](../../../../doc/project_governance/checklist/README.md)
diff --git a/hw/ip/entropy_src/dv/README.md b/hw/ip/entropy_src/dv/README.md
index ac6bbe7..76715c0 100644
--- a/hw/ip/entropy_src/dv/README.md
+++ b/hw/ip/entropy_src/dv/README.md
@@ -1,6 +1,4 @@
----
-title: "ENTROPY_SRC DV document"
----
+# ENTROPY_SRC DV document
## Goals
* **DV**
diff --git a/hw/ip/flash_ctrl/README.md b/hw/ip/flash_ctrl/README.md
index f780e8c..823d853 100644
--- a/hw/ip/flash_ctrl/README.md
+++ b/hw/ip/flash_ctrl/README.md
@@ -1,6 +1,4 @@
----
-title: "Flash Controller HWIP Technical Specification"
----
+# Flash Controller HWIP Technical Specification
# Overview
diff --git a/hw/ip/flash_ctrl/doc/checklist.md b/hw/ip/flash_ctrl/doc/checklist.md
index 46216bb..0f9712c 100644
--- a/hw/ip/flash_ctrl/doc/checklist.md
+++ b/hw/ip/flash_ctrl/doc/checklist.md
@@ -1,6 +1,4 @@
----
-title: "FLASH_CTRL Checklist"
----
+# FLASH_CTRL Checklist
This checklist is for [Hardware Stage](../../../../doc/project_governance/development_stages.md) transitions for the [FLASH_CTRL peripheral.](../README.md)
All checklist items refer to the content in the [Checklist.](../../../../doc/project_governance/checklist/README.md)
diff --git a/hw/ip/flash_ctrl/dv/README.md b/hw/ip/flash_ctrl/dv/README.md
index 9b76902..c312ed4 100644
--- a/hw/ip/flash_ctrl/dv/README.md
+++ b/hw/ip/flash_ctrl/dv/README.md
@@ -1,6 +1,4 @@
----
-title: "FLASH_CTRL DV document"
----
+# FLASH_CTRL DV document
## Goals
* **DV**
diff --git a/hw/ip/gpio/README.md b/hw/ip/gpio/README.md
index 4301745..5e76c22 100644
--- a/hw/ip/gpio/README.md
+++ b/hw/ip/gpio/README.md
@@ -1,6 +1,4 @@
----
-title: "GPIO HWIP Technical Specification"
----
+# GPIO HWIP Technical Specification
# Overview
diff --git a/hw/ip/gpio/doc/checklist.md b/hw/ip/gpio/doc/checklist.md
index 9f564a2..36e8b7c 100644
--- a/hw/ip/gpio/doc/checklist.md
+++ b/hw/ip/gpio/doc/checklist.md
@@ -1,6 +1,4 @@
----
-title: "GPIO Checklist"
----
+# GPIO Checklist
This checklist is for [Hardware Stage](../../../../doc/project_governance/development_stages.md) transitions for the [GPIO peripheral][GPIO Spec].
All checklist items refer to the content in the [Checklist.](../../../../doc/project_governance/checklist/README.md)
diff --git a/hw/ip/gpio/dv/README.md b/hw/ip/gpio/dv/README.md
index 834d6f9..86765dd 100644
--- a/hw/ip/gpio/dv/README.md
+++ b/hw/ip/gpio/dv/README.md
@@ -1,6 +1,4 @@
----
-title: "GPIO DV document"
----
+# GPIO DV document
## Goals
* **DV**
diff --git a/hw/ip/hmac/README.md b/hw/ip/hmac/README.md
index 33c3c5a..4b8f6aa 100644
--- a/hw/ip/hmac/README.md
+++ b/hw/ip/hmac/README.md
@@ -1,6 +1,4 @@
----
-title: "HMAC HWIP Technical Specification"
----
+# HMAC HWIP Technical Specification
# Overview
diff --git a/hw/ip/hmac/doc/checklist.md b/hw/ip/hmac/doc/checklist.md
index 18ba03c..6ae8f08 100644
--- a/hw/ip/hmac/doc/checklist.md
+++ b/hw/ip/hmac/doc/checklist.md
@@ -1,6 +1,4 @@
----
-title: "HMAC Checklist"
----
+# HMAC Checklist
This checklist is for [Hardware Stage](../../../../doc/project_governance/development_stages.md) transitions for the [HMAC peripheral](../README.md).
All checklist items refer to the content in the [Checklist.](../../../../doc/project_governance/checklist/README.md)
diff --git a/hw/ip/hmac/dv/README.md b/hw/ip/hmac/dv/README.md
index 85182cd..02d391c 100644
--- a/hw/ip/hmac/dv/README.md
+++ b/hw/ip/hmac/dv/README.md
@@ -1,6 +1,4 @@
----
-title: "HMAC DV document"
----
+# HMAC DV document
## Goals
* **DV**
diff --git a/hw/ip/i2c/README.md b/hw/ip/i2c/README.md
index b8abfcd..493b57a 100644
--- a/hw/ip/i2c/README.md
+++ b/hw/ip/i2c/README.md
@@ -1,6 +1,4 @@
----
-title: "I2C HWIP Technical Specification"
----
+# I2C HWIP Technical Specification
# Overview
diff --git a/hw/ip/i2c/doc/checklist.md b/hw/ip/i2c/doc/checklist.md
index 1e56396..146901f 100644
--- a/hw/ip/i2c/doc/checklist.md
+++ b/hw/ip/i2c/doc/checklist.md
@@ -1,6 +1,4 @@
----
-title: "I2C Checklist"
----
+# I2C Checklist
This checklist is for [Hardware Stage][] transitions for the [I2C peripheral.](../README.md)
All checklist items refer to the content in the [Checklist.](../../../../doc/project_governance/checklist/README.md)
diff --git a/hw/ip/i2c/dv/README.md b/hw/ip/i2c/dv/README.md
index a1a7894..d964f73 100644
--- a/hw/ip/i2c/dv/README.md
+++ b/hw/ip/i2c/dv/README.md
@@ -1,6 +1,4 @@
----
-title: "I2C DV document"
----
+# I2C DV document
## Goals
* **DV**
diff --git a/hw/ip/keymgr/README.md b/hw/ip/keymgr/README.md
index a9c2a0a..6687667 100644
--- a/hw/ip/keymgr/README.md
+++ b/hw/ip/keymgr/README.md
@@ -1,6 +1,4 @@
----
-title: "Key Manager HWIP Technical Specification"
----
+# Key Manager HWIP Technical Specification
# Overview
diff --git a/hw/ip/keymgr/doc/checklist.md b/hw/ip/keymgr/doc/checklist.md
index 7997759..c952165 100644
--- a/hw/ip/keymgr/doc/checklist.md
+++ b/hw/ip/keymgr/doc/checklist.md
@@ -1,6 +1,4 @@
----
-title: "KEYMGR Checklist"
----
+# KEYMGR Checklist
<!--
NOTE: This is a template checklist document that is required to be copied over to the 'doc'
diff --git a/hw/ip/keymgr/dv/README.md b/hw/ip/keymgr/dv/README.md
index af5b3e2..bf3e6f4 100644
--- a/hw/ip/keymgr/dv/README.md
+++ b/hw/ip/keymgr/dv/README.md
@@ -1,6 +1,4 @@
----
-title: "KEYMGR DV document"
----
+# KEYMGR DV document
## Goals
* **DV**
diff --git a/hw/ip/kmac/README.md b/hw/ip/kmac/README.md
index 946e4ce..c070405 100644
--- a/hw/ip/kmac/README.md
+++ b/hw/ip/kmac/README.md
@@ -1,6 +1,4 @@
----
-title: "KMAC HWIP Technical Specification"
----
+# KMAC HWIP Technical Specification
# Overview
diff --git a/hw/ip/kmac/doc/checklist.md b/hw/ip/kmac/doc/checklist.md
index fefdd4c..d774a08 100644
--- a/hw/ip/kmac/doc/checklist.md
+++ b/hw/ip/kmac/doc/checklist.md
@@ -1,6 +1,4 @@
----
-title: "KMAC Checklist"
----
+# KMAC Checklist
This checklist is for [Hardware Stage](../../../../doc/project_governance/development_stages.md) transitions for the [KMAC peripheral](../README.md).
All checklist items refer to the content in the [Checklist.](../../../../doc/project_governance/checklist/README.md)
diff --git a/hw/ip/kmac/dv/README.md b/hw/ip/kmac/dv/README.md
index 774316b..536df27 100644
--- a/hw/ip/kmac/dv/README.md
+++ b/hw/ip/kmac/dv/README.md
@@ -1,6 +1,4 @@
----
-title: "KMAC DV document"
----
+# KMAC DV document
## Goals
* **DV**
diff --git a/hw/ip/lc_ctrl/README.md b/hw/ip/lc_ctrl/README.md
index 4062914..4d507b4 100644
--- a/hw/ip/lc_ctrl/README.md
+++ b/hw/ip/lc_ctrl/README.md
@@ -1,6 +1,4 @@
----
-title: "Life Cycle Controller Technical Specification"
----
+# Life Cycle Controller Technical Specification
# Overview
diff --git a/hw/ip/lc_ctrl/doc/checklist.md b/hw/ip/lc_ctrl/doc/checklist.md
index 42fd7f4..e03383c 100644
--- a/hw/ip/lc_ctrl/doc/checklist.md
+++ b/hw/ip/lc_ctrl/doc/checklist.md
@@ -1,6 +1,4 @@
----
-title: "LC_CTRL Checklist"
----
+# LC_CTRL Checklist
<!--
NOTE: This is a template checklist document that is required to be copied over to the 'doc'
diff --git a/hw/ip/lc_ctrl/dv/README.md b/hw/ip/lc_ctrl/dv/README.md
index 31acf28..fb40721 100644
--- a/hw/ip/lc_ctrl/dv/README.md
+++ b/hw/ip/lc_ctrl/dv/README.md
@@ -1,6 +1,4 @@
----
-title: "LC_CTRL DV document"
----
+# LC_CTRL DV document
## Goals
* **DV**
diff --git a/hw/ip/otbn/README.md b/hw/ip/otbn/README.md
index 5a0eed8..5e923da 100644
--- a/hw/ip/otbn/README.md
+++ b/hw/ip/otbn/README.md
@@ -1,6 +1,4 @@
----
-title: OpenTitan Big Number Accelerator (OTBN) Technical Specification
----
+# OpenTitan Big Number Accelerator (OTBN) Technical Specification
# Overview
diff --git a/hw/ip/otbn/doc/checklist.md b/hw/ip/otbn/doc/checklist.md
index 48e9289..e158184 100644
--- a/hw/ip/otbn/doc/checklist.md
+++ b/hw/ip/otbn/doc/checklist.md
@@ -1,6 +1,4 @@
----
-title: "OTBN Checklist"
----
+# OTBN Checklist
This checklist is for [Hardware Stage](../../../../doc/project_governance/development_stages.md) transitions for the [OTBN peripheral.](../README.md)
All checklist items refer to the content in the [Checklist.](../../../../doc/project_governance/checklist/README.md)
diff --git a/hw/ip/otbn/doc/isa.md b/hw/ip/otbn/doc/isa.md
index 6b56fb8..8952e6b 100644
--- a/hw/ip/otbn/doc/isa.md
+++ b/hw/ip/otbn/doc/isa.md
@@ -1,6 +1,4 @@
----
-title: OpenTitan Big Number Accelerator (OTBN) Instruction Set Architecture
----
+# OpenTitan Big Number Accelerator (OTBN) Instruction Set Architecture
This document describes the instruction set for OTBN.
For more details about the processor itself, see the [OTBN Technical Specification](../README.md).
diff --git a/hw/ip/otbn/dv/README.md b/hw/ip/otbn/dv/README.md
index 64c098c..b1382da 100644
--- a/hw/ip/otbn/dv/README.md
+++ b/hw/ip/otbn/dv/README.md
@@ -1,6 +1,4 @@
----
-title: "OTBN DV document"
----
+# OTBN DV document
## Goals
* **DV**
diff --git a/hw/ip/otbn/dv/doc/fcov.md b/hw/ip/otbn/dv/doc/fcov.md
index 5755b08..4a93d89 100644
--- a/hw/ip/otbn/dv/doc/fcov.md
+++ b/hw/ip/otbn/dv/doc/fcov.md
@@ -1,6 +1,4 @@
----
-title: "OTBN functional coverage"
----
+# OTBN functional coverage
We distinguish between *architectural* and *micro-architectural* functional coverage.
The idea is that the points that go into architectural coverage are those that a DV engineer could derive by reading the block specification.
diff --git a/hw/ip/otp_ctrl/README.md b/hw/ip/otp_ctrl/README.md
index f2c1e55..a9aa5e7 100644
--- a/hw/ip/otp_ctrl/README.md
+++ b/hw/ip/otp_ctrl/README.md
@@ -1,6 +1,4 @@
----
-title: "OTP Controller Technical Specification"
----
+# OTP Controller Technical Specification
# Overview
diff --git a/hw/ip/otp_ctrl/doc/checklist.md b/hw/ip/otp_ctrl/doc/checklist.md
index c8fd2e4..5554f23 100644
--- a/hw/ip/otp_ctrl/doc/checklist.md
+++ b/hw/ip/otp_ctrl/doc/checklist.md
@@ -1,6 +1,4 @@
----
-title: "OTP_CTRL Checklist"
----
+# OTP_CTRL Checklist
<!--
NOTE: This is a template checklist document that is required to be copied over to the 'doc'
diff --git a/hw/ip/otp_ctrl/dv/README.md b/hw/ip/otp_ctrl/dv/README.md
index d7b127f..16db6bd 100644
--- a/hw/ip/otp_ctrl/dv/README.md
+++ b/hw/ip/otp_ctrl/dv/README.md
@@ -1,6 +1,4 @@
----
-title: "OTP_CTRL DV document"
----
+# OTP_CTRL DV document
## Goals
* **DV**
diff --git a/hw/ip/pattgen/README.md b/hw/ip/pattgen/README.md
index 7e3cc9c..d2b9bcd 100644
--- a/hw/ip/pattgen/README.md
+++ b/hw/ip/pattgen/README.md
@@ -1,6 +1,4 @@
----
-title: "Pattern Generator HWIP Technical Specification"
----
+# Pattern Generator HWIP Technical Specification
# Overview
diff --git a/hw/ip/pattgen/doc/checklist.md b/hw/ip/pattgen/doc/checklist.md
index 5af0cea..ebcfc38 100644
--- a/hw/ip/pattgen/doc/checklist.md
+++ b/hw/ip/pattgen/doc/checklist.md
@@ -1,6 +1,4 @@
----
-title: "Pattgen Checklist"
----
+# Pattgen Checklist
This checklist is for [Hardware Stage](../../../../doc/project_governance/development_stages.md) transitions for the [Pattgen peripheral.](../README.md)
All checklist items refer to the content in the [Checklist.](../../../../doc/project_governance/checklist/README.md)
diff --git a/hw/ip/pattgen/dv/README.md b/hw/ip/pattgen/dv/README.md
index 2662956..782e222 100644
--- a/hw/ip/pattgen/dv/README.md
+++ b/hw/ip/pattgen/dv/README.md
@@ -1,6 +1,4 @@
----
-title: "PATTGEN DV document"
----
+# PATTGEN DV document
## Goals
* **DV**
diff --git a/hw/ip/pinmux/README.md b/hw/ip/pinmux/README.md
index 5d969f0..c9c74d6 100644
--- a/hw/ip/pinmux/README.md
+++ b/hw/ip/pinmux/README.md
@@ -1,6 +1,4 @@
----
-title: "Pinmux Technical Specification"
----
+# Pinmux Technical Specification
# Overview
diff --git a/hw/ip/pinmux/doc/checklist.md b/hw/ip/pinmux/doc/checklist.md
index 464658f..c49a72c 100644
--- a/hw/ip/pinmux/doc/checklist.md
+++ b/hw/ip/pinmux/doc/checklist.md
@@ -1,6 +1,4 @@
----
-title: "Pinmux Checklist"
----
+# Pinmux Checklist
This checklist is for [Hardware Stage](../../../../doc/project_governance/development_stages.md) transitions for the [Pinmux peripheral.](../README.md)
All checklist items refer to the content in the [Checklist.](../../../../doc/project_governance/checklist/README.md)
diff --git a/hw/ip/pinmux/doc/dv/README.md b/hw/ip/pinmux/doc/dv/README.md
index a69d1b2..09eb8a6 100644
--- a/hw/ip/pinmux/doc/dv/README.md
+++ b/hw/ip/pinmux/doc/dv/README.md
@@ -1,6 +1,4 @@
----
-title: "PINMUX DV document"
----
+# PINMUX DV document
## Goals
* **DV**:
diff --git a/hw/ip/prim/README.md b/hw/ip/prim/README.md
index aad1c9d..789f8c8 100644
--- a/hw/ip/prim/README.md
+++ b/hw/ip/prim/README.md
@@ -1,6 +1,4 @@
----
-title: "lowRISC Hardware Primitives"
----
+# lowRISC Hardware Primitives
## Concepts
diff --git a/hw/ip/prim/doc/prim_clock_gp_mux2.md b/hw/ip/prim/doc/prim_clock_gp_mux2.md
index a3e75c8..460d8b8 100644
--- a/hw/ip/prim/doc/prim_clock_gp_mux2.md
+++ b/hw/ip/prim/doc/prim_clock_gp_mux2.md
@@ -1,6 +1,4 @@
----
-title: "Primitive Component: Two input clock Mux with glitch protection"
----
+# Primitive Component: Two input clock Mux with glitch protection
# Overview
`prim_clock_gp_mux2` is a two input clock mux that protects a glitch. When a current clock source is switched to the next clock source where two clocks are totally unrelated, a glitch can be generated as follows.
diff --git a/hw/ip/prim/doc/prim_flash.md b/hw/ip/prim/doc/prim_flash.md
index ecf0901..a187d9d 100644
--- a/hw/ip/prim/doc/prim_flash.md
+++ b/hw/ip/prim/doc/prim_flash.md
@@ -1,6 +1,4 @@
----
-title: "Primitive Component: Flash Wrapper"
----
+# Primitive Component: Flash Wrapper
# Overview
`prim_flash` is a wrapper interface for technology specific flash modules.
diff --git a/hw/ip/prim/doc/prim_keccak.md b/hw/ip/prim/doc/prim_keccak.md
index 0a63c71..122489e 100644
--- a/hw/ip/prim/doc/prim_keccak.md
+++ b/hw/ip/prim/doc/prim_keccak.md
@@ -1,6 +1,4 @@
----
-title: "Primitive Component: Keccak permutation"
----
+# Primitive Component: Keccak permutation
# Overview
diff --git a/hw/ip/prim/doc/prim_lfsr.md b/hw/ip/prim/doc/prim_lfsr.md
index a9c3af9..a9a0178 100644
--- a/hw/ip/prim/doc/prim_lfsr.md
+++ b/hw/ip/prim/doc/prim_lfsr.md
@@ -1,6 +1,4 @@
----
-title: "Primitive Component: LFSR"
----
+# Primitive Component: LFSR
# Overview
diff --git a/hw/ip/prim/doc/prim_packer.md b/hw/ip/prim/doc/prim_packer.md
index c5fdf19..f870315 100644
--- a/hw/ip/prim/doc/prim_packer.md
+++ b/hw/ip/prim/doc/prim_packer.md
@@ -1,6 +1,4 @@
----
-title: "Primitive Component: Packer"
----
+# Primitive Component: Packer
# Overview
diff --git a/hw/ip/prim/doc/prim_packer_fifo.md b/hw/ip/prim/doc/prim_packer_fifo.md
index f3ad487..b79f565 100644
--- a/hw/ip/prim/doc/prim_packer_fifo.md
+++ b/hw/ip/prim/doc/prim_packer_fifo.md
@@ -1,6 +1,4 @@
----
-title: "Primitive Component: Packer FIFO"
----
+# Primitive Component: Packer FIFO
# Overview
diff --git a/hw/ip/prim/doc/prim_present.md b/hw/ip/prim/doc/prim_present.md
index 858b71e..b1b2452 100644
--- a/hw/ip/prim/doc/prim_present.md
+++ b/hw/ip/prim/doc/prim_present.md
@@ -1,6 +1,4 @@
----
-title: "Primitive Component: PRESENT Scrambler"
----
+# Primitive Component: PRESENT Scrambler
# Overview
diff --git a/hw/ip/prim/doc/prim_prince.md b/hw/ip/prim/doc/prim_prince.md
index e33d150..5c56bd0 100644
--- a/hw/ip/prim/doc/prim_prince.md
+++ b/hw/ip/prim/doc/prim_prince.md
@@ -1,6 +1,4 @@
----
-title: "Primitive Component: PRINCE Scrambler"
----
+# Primitive Component: PRINCE Scrambler
# Overview
@@ -120,5 +118,3 @@
The reduced 32bit variant mentioned above and all reduced round variants are non-standard and must only be used for scrambling purposes, since they **are not secure**.
The 32bit variant leverages the same crypto primitives and key derivation functions as the 64bit variant, with the difference that the multiplication matrix is only comprised of the first two block diagonal submatrices (^M0 and ^M1 in the paper), and the shiftrows operation does not operate on nibbles but pairs of 2 bits instead.
-
-
diff --git a/hw/ip/prim/doc/prim_ram_1p_scr.md b/hw/ip/prim/doc/prim_ram_1p_scr.md
index 5c55be1..ffdaebc 100644
--- a/hw/ip/prim/doc/prim_ram_1p_scr.md
+++ b/hw/ip/prim/doc/prim_ram_1p_scr.md
@@ -1,6 +1,4 @@
----
-title: "Primitive Component: SRAM Scrambler"
----
+# Primitive Component: SRAM Scrambler
# Overview
diff --git a/hw/ip/prim/doc/prim_xoshiro256pp.md b/hw/ip/prim/doc/prim_xoshiro256pp.md
index 8e62303..2d76852 100644
--- a/hw/ip/prim/doc/prim_xoshiro256pp.md
+++ b/hw/ip/prim/doc/prim_xoshiro256pp.md
@@ -1,6 +1,4 @@
----
-title: "Primitive Component: XoShiRo256++"
----
+# Primitive Component: XoShiRo256++
# Overviewtitle
diff --git a/hw/ip/pwm/README.md b/hw/ip/pwm/README.md
index 473b5d6..8cd40fe 100644
--- a/hw/ip/pwm/README.md
+++ b/hw/ip/pwm/README.md
@@ -1,6 +1,4 @@
----
-title: "PWM HWIP Technical Specification"
----
+# PWM HWIP Technical Specification
# Overview
diff --git a/hw/ip/pwm/doc/checklist.md b/hw/ip/pwm/doc/checklist.md
index 061cbd3..30184e6 100644
--- a/hw/ip/pwm/doc/checklist.md
+++ b/hw/ip/pwm/doc/checklist.md
@@ -1,6 +1,4 @@
----
-title: "PWM Checklist"
----
+# PWM Checklist
This checklist is for [Hardware Stage](../../../../doc/project_governance/development_stages.md) transitions for the [PWM peripheral.](../README.md)
All checklist items refer to the content in the [Checklist.](../../../../doc/project_governance/checklist/README.md)
diff --git a/hw/ip/pwm/dv/README.md b/hw/ip/pwm/dv/README.md
index d41a63d..3b5c767 100644
--- a/hw/ip/pwm/dv/README.md
+++ b/hw/ip/pwm/dv/README.md
@@ -1,6 +1,4 @@
----
-title: "PWM DV document"
----
+# PWM DV document
## Goals
* **DV**
diff --git a/hw/ip/pwrmgr/README.md b/hw/ip/pwrmgr/README.md
index 56ce791..fbb1005 100644
--- a/hw/ip/pwrmgr/README.md
+++ b/hw/ip/pwrmgr/README.md
@@ -1,6 +1,4 @@
----
-title: "Power Manager HWIP Technical Specification"
----
+# Power Manager HWIP Technical Specification
# Overview
diff --git a/hw/ip/pwrmgr/doc/checklist.md b/hw/ip/pwrmgr/doc/checklist.md
index 373e4f8..d62e270 100644
--- a/hw/ip/pwrmgr/doc/checklist.md
+++ b/hw/ip/pwrmgr/doc/checklist.md
@@ -1,6 +1,4 @@
----
-title: "PWRMGR Checklist"
----
+# PWRMGR Checklist
This checklist is for [Hardware Stage](../../../../doc/project_governance/development_stages.md) transitions for the [PWRMGR peripheral.](../README.md)
All checklist items refer to the content in the [Checklist.](../../../../doc/project_governance/checklist/README.md)
diff --git a/hw/ip/pwrmgr/dv/README.md b/hw/ip/pwrmgr/dv/README.md
index c86d2b5..31278f4 100644
--- a/hw/ip/pwrmgr/dv/README.md
+++ b/hw/ip/pwrmgr/dv/README.md
@@ -1,6 +1,4 @@
----
-title: "PWRMGR DV document"
----
+# PWRMGR DV document
## Goals
* **DV**
diff --git a/hw/ip/rom_ctrl/README.md b/hw/ip/rom_ctrl/README.md
index 1230ef8..ed25ac2 100644
--- a/hw/ip/rom_ctrl/README.md
+++ b/hw/ip/rom_ctrl/README.md
@@ -1,6 +1,4 @@
----
-title: ROM Controller Technical Specification
----
+# ROM Controller Technical Specification
# Overview
diff --git a/hw/ip/rom_ctrl/doc/checklist.md b/hw/ip/rom_ctrl/doc/checklist.md
index a6a4735..b53a1b1 100644
--- a/hw/ip/rom_ctrl/doc/checklist.md
+++ b/hw/ip/rom_ctrl/doc/checklist.md
@@ -1,6 +1,4 @@
----
-title: "Rom Controller Checklist"
----
+# Rom Controller Checklist
This checklist is for [Hardware Stage](../../../../doc/project_governance/development_stages.md) transitions for the [ROM Controller peripheral.](../README.md)
All checklist items refer to the content in the [Checklist.](../../../../doc/project_governance/checklist/README.md)
diff --git a/hw/ip/rom_ctrl/dv/README.md b/hw/ip/rom_ctrl/dv/README.md
index 4a83d9c..8b8f77b 100644
--- a/hw/ip/rom_ctrl/dv/README.md
+++ b/hw/ip/rom_ctrl/dv/README.md
@@ -1,6 +1,4 @@
----
-title: "ROM Controller DV document"
----
+# ROM Controller DV document
## Goals
* **DV**
diff --git a/hw/ip/rstmgr/README.md b/hw/ip/rstmgr/README.md
index f04cf39..095d740 100644
--- a/hw/ip/rstmgr/README.md
+++ b/hw/ip/rstmgr/README.md
@@ -1,6 +1,4 @@
----
-title: "Reset Manager HWIP Technical Specification"
----
+# Reset Manager HWIP Technical Specification
# Overview
diff --git a/hw/ip/rstmgr/doc/checklist.md b/hw/ip/rstmgr/doc/checklist.md
index df61a66..d5cd380 100644
--- a/hw/ip/rstmgr/doc/checklist.md
+++ b/hw/ip/rstmgr/doc/checklist.md
@@ -1,6 +1,4 @@
----
-title: "RSTMGR Checklist"
----
+# RSTMGR Checklist
This checklist is for [Hardware Stage](../../../../doc/project_governance/development_stages.md) transitions for the [RSTMGR peripheral.](../README.md)
All checklist items refer to the content in the [Checklist.](../../../../doc/project_governance/checklist/README.md)
diff --git a/hw/ip/rstmgr/dv/README.md b/hw/ip/rstmgr/dv/README.md
index 6a3af54..6f50373 100644
--- a/hw/ip/rstmgr/dv/README.md
+++ b/hw/ip/rstmgr/dv/README.md
@@ -1,6 +1,4 @@
----
-title: "RSTMGR DV document"
----
+# RSTMGR DV document
## Goals
* **DV**
diff --git a/hw/ip/rv_core_ibex/README.md b/hw/ip/rv_core_ibex/README.md
index f7f49a6..ae07b34 100644
--- a/hw/ip/rv_core_ibex/README.md
+++ b/hw/ip/rv_core_ibex/README.md
@@ -1,6 +1,4 @@
----
-title: "Ibex RISC-V Core Wrapper Technical Specification"
----
+# Ibex RISC-V Core Wrapper Technical Specification
# Overview
diff --git a/hw/ip/rv_core_ibex/doc/checklist.md b/hw/ip/rv_core_ibex/doc/checklist.md
index 4790acb..5637b93 100644
--- a/hw/ip/rv_core_ibex/doc/checklist.md
+++ b/hw/ip/rv_core_ibex/doc/checklist.md
@@ -1,6 +1,4 @@
----
-title: "Ibex Processor Core Checklist"
----
+# Ibex Processor Core Checklist
This checklist is for [Hardware Stage][] transitions for the [Ibex Processor Core.](../README.md)
All checklist items refer to the content in the [Checklist.](../../../../doc/project_governance/checklist/README.md)
diff --git a/hw/ip/rv_core_ibex/dv/README.md b/hw/ip/rv_core_ibex/dv/README.md
index 5c92ff8..8dd7f43 100644
--- a/hw/ip/rv_core_ibex/dv/README.md
+++ b/hw/ip/rv_core_ibex/dv/README.md
@@ -1,6 +1,4 @@
----
-title: "Ibex RISC-V Core Wrapper DV document"
----
+# Ibex RISC-V Core Wrapper DV document
## Goals
* Verify compliance with the RISC-V specifications used by OpenTitan.
diff --git a/hw/ip/rv_dm/README.md b/hw/ip/rv_dm/README.md
index 0666edb..609052b 100644
--- a/hw/ip/rv_dm/README.md
+++ b/hw/ip/rv_dm/README.md
@@ -1,6 +1,4 @@
----
-title: "RISC-V Debug System Wrapper Technical Specification"
----
+# RISC-V Debug System Wrapper Technical Specification
# Overview
This document specifies the RISC-V Debug System wrapper functionality.
diff --git a/hw/ip/rv_dm/doc/checklist.md b/hw/ip/rv_dm/doc/checklist.md
index 50be755..a385473 100644
--- a/hw/ip/rv_dm/doc/checklist.md
+++ b/hw/ip/rv_dm/doc/checklist.md
@@ -1,6 +1,4 @@
----
-title: "RV_DM Checklist"
----
+# RV_DM Checklist
This checklist is for [Hardware Stage](../../../../doc/project_governance/development_stages.md) transitions for the [RV_DM peripheral.](../README.md)
All checklist items refer to the content in the [Checklist.](../../../../doc/project_governance/checklist/README.md)
diff --git a/hw/ip/rv_dm/dv/README.md b/hw/ip/rv_dm/dv/README.md
index 36f0ab1..da3d665 100644
--- a/hw/ip/rv_dm/dv/README.md
+++ b/hw/ip/rv_dm/dv/README.md
@@ -1,6 +1,4 @@
----
-title: "RV_DM DV document"
----
+# RV_DM DV document
## Goals
* **DV**
diff --git a/hw/ip/rv_timer/README.md b/hw/ip/rv_timer/README.md
index e9231df..e4d356e 100644
--- a/hw/ip/rv_timer/README.md
+++ b/hw/ip/rv_timer/README.md
@@ -1,6 +1,4 @@
----
-title: "Timer HWIP Technical Specification"
----
+# Timer HWIP Technical Specification
# Overview
diff --git a/hw/ip/rv_timer/doc/checklist.md b/hw/ip/rv_timer/doc/checklist.md
index 0888539..994541a 100644
--- a/hw/ip/rv_timer/doc/checklist.md
+++ b/hw/ip/rv_timer/doc/checklist.md
@@ -1,6 +1,4 @@
----
-title: "RV_TIMER Checklist"
----
+# RV_TIMER Checklist
This checklist is for [Hardware Stage](../../../../doc/project_governance/development_stages.md)
transitions for the [rv_timer peripheral.](../README.md) All checklist
diff --git a/hw/ip/rv_timer/dv/README.md b/hw/ip/rv_timer/dv/README.md
index 97cd3aa..df37448 100644
--- a/hw/ip/rv_timer/dv/README.md
+++ b/hw/ip/rv_timer/dv/README.md
@@ -1,6 +1,4 @@
----
-title: "RV_TIMER DV document"
----
+# RV_TIMER DV document
## Goals
* **DV**
diff --git a/hw/ip/spi_device/README.md b/hw/ip/spi_device/README.md
index 08fd212..2aad706 100644
--- a/hw/ip/spi_device/README.md
+++ b/hw/ip/spi_device/README.md
@@ -1,6 +1,4 @@
----
-title: "SPI Device HWIP Technical Specification"
----
+# SPI Device HWIP Technical Specification
# Overview
diff --git a/hw/ip/spi_device/doc/checklist.md b/hw/ip/spi_device/doc/checklist.md
index 0106e94..4a10ca3 100644
--- a/hw/ip/spi_device/doc/checklist.md
+++ b/hw/ip/spi_device/doc/checklist.md
@@ -1,6 +1,4 @@
----
-title: "SPI_DEVICE Checklist"
----
+# SPI_DEVICE Checklist
This checklist is for [Hardware Stage](../../../../doc/project_governance/development_stages.md) transitions for the [spi_device peripheral](../README.md).
All checklist items refer to the content in the [Checklist](../../../../doc/project_governance/checklist/README.md).
diff --git a/hw/ip/spi_device/dv/README.md b/hw/ip/spi_device/dv/README.md
index facf32f..34c0ffc 100644
--- a/hw/ip/spi_device/dv/README.md
+++ b/hw/ip/spi_device/dv/README.md
@@ -1,6 +1,4 @@
----
-title: "SPI Device DV document"
----
+# SPI Device DV document
## Goals
diff --git a/hw/ip/spi_host/README.md b/hw/ip/spi_host/README.md
index 1ecd193..1400346 100644
--- a/hw/ip/spi_host/README.md
+++ b/hw/ip/spi_host/README.md
@@ -1,6 +1,4 @@
----
-title: "SPI_HOST HWIP Technical Specification"
----
+# SPI_HOST HWIP Technical Specification
# Overview
diff --git a/hw/ip/spi_host/doc/checklist.md b/hw/ip/spi_host/doc/checklist.md
index c23bd66..27cf812 100644
--- a/hw/ip/spi_host/doc/checklist.md
+++ b/hw/ip/spi_host/doc/checklist.md
@@ -1,6 +1,4 @@
----
-title: "SPI_HOST Checklist"
----
+# SPI_HOST Checklist
<!--
NOTE: This is a template checklist document that is required to be copied over to the 'doc'
diff --git a/hw/ip/spi_host/dv/README.md b/hw/ip/spi_host/dv/README.md
index 426dc51..ef36f08 100644
--- a/hw/ip/spi_host/dv/README.md
+++ b/hw/ip/spi_host/dv/README.md
@@ -1,6 +1,4 @@
----
-title: "SPI_HOST DV Document"
----
+# SPI_HOST DV Document
## Goals
* **DV**
diff --git a/hw/ip/sram_ctrl/README.md b/hw/ip/sram_ctrl/README.md
index 5e51820..f7fe727 100644
--- a/hw/ip/sram_ctrl/README.md
+++ b/hw/ip/sram_ctrl/README.md
@@ -1,6 +1,4 @@
----
-title: "SRAM Controller Technical Specification"
----
+# SRAM Controller Technical Specification
# Overview
diff --git a/hw/ip/sram_ctrl/doc/checklist.md b/hw/ip/sram_ctrl/doc/checklist.md
index c6880cb..d6709d5 100644
--- a/hw/ip/sram_ctrl/doc/checklist.md
+++ b/hw/ip/sram_ctrl/doc/checklist.md
@@ -1,6 +1,4 @@
----
-title: "SRAM_CTRL Checklist"
----
+# SRAM_CTRL Checklist
This checklist is for [Hardware Stage](../../../../doc/project_governance/development_stages.md) transitions for the [SRAM_CTRL peripheral.](../README.md)
All checklist items refer to the content in the [Checklist.](../../../../doc/project_governance/checklist/README.md)
diff --git a/hw/ip/sram_ctrl/dv/README.md b/hw/ip/sram_ctrl/dv/README.md
index 97f2e3d..e10741f 100644
--- a/hw/ip/sram_ctrl/dv/README.md
+++ b/hw/ip/sram_ctrl/dv/README.md
@@ -1,6 +1,4 @@
----
-title: "SRAM_CTRL DV document"
----
+# SRAM_CTRL DV document
## Goals
* **DV**
diff --git a/hw/ip/sysrst_ctrl/README.md b/hw/ip/sysrst_ctrl/README.md
index 9e8253f..03914bb 100644
--- a/hw/ip/sysrst_ctrl/README.md
+++ b/hw/ip/sysrst_ctrl/README.md
@@ -1,6 +1,4 @@
----
-title: "System Reset Control Technical Specification"
----
+# System Reset Control Technical Specification
# Overview
diff --git a/hw/ip/sysrst_ctrl/doc/checklist.md b/hw/ip/sysrst_ctrl/doc/checklist.md
index 37d05ea..1f3cfd6 100644
--- a/hw/ip/sysrst_ctrl/doc/checklist.md
+++ b/hw/ip/sysrst_ctrl/doc/checklist.md
@@ -1,6 +1,4 @@
----
-title: "SYSRST_CTRL Checklist"
----
+# SYSRST_CTRL Checklist
This checklist is for [Hardware Stage](../../../../doc/project_governance/development_stages.md) transitions for the [SYSRST_CTRL peripheral.](../README.md)
All checklist items refer to the content in the [Checklist.](../../../../doc/project_governance/checklist/README.md)
diff --git a/hw/ip/sysrst_ctrl/dv/README.md b/hw/ip/sysrst_ctrl/dv/README.md
index 2e5a632..8a43435 100644
--- a/hw/ip/sysrst_ctrl/dv/README.md
+++ b/hw/ip/sysrst_ctrl/dv/README.md
@@ -1,6 +1,4 @@
----
-title: "SYSRST_CTRL DV document"
----
+# SYSRST_CTRL DV document
<!-- Copy this file to hw/ip/sysrst_ctrl/doc/dv/index.md and make changes as needed.
For convenience 'sysrst_ctrl' in the document can be searched and replaced easily with the
diff --git a/hw/ip/tlul/README.md b/hw/ip/tlul/README.md
index 3eb750d..3883359 100644
--- a/hw/ip/tlul/README.md
+++ b/hw/ip/tlul/README.md
@@ -1,6 +1,4 @@
----
-title: "Bus Specification"
----
+# Bus Specification
# Overview
diff --git a/hw/ip/tlul/doc/TlulProtocolChecker.md b/hw/ip/tlul/doc/TlulProtocolChecker.md
index 8c4cf25..684d110 100644
--- a/hw/ip/tlul/doc/TlulProtocolChecker.md
+++ b/hw/ip/tlul/doc/TlulProtocolChecker.md
@@ -1,6 +1,4 @@
----
-title: "TL-UL Protocol Checker"
----
+# TL-UL Protocol Checker
# TileLink-UL Protocol Checker
diff --git a/hw/ip/tlul/doc/dv/README.md b/hw/ip/tlul/doc/dv/README.md
index 03141ab..dcf04d9 100644
--- a/hw/ip/tlul/doc/dv/README.md
+++ b/hw/ip/tlul/doc/dv/README.md
@@ -1,6 +1,4 @@
----
-title: "TLUL XBAR DV document"
----
+# TLUL XBAR DV document
## Goals
diff --git a/hw/ip/uart/README.md b/hw/ip/uart/README.md
index 44728f4..b3c19bc 100644
--- a/hw/ip/uart/README.md
+++ b/hw/ip/uart/README.md
@@ -1,6 +1,4 @@
----
-title: "UART HWIP Technical Specification"
----
+# UART HWIP Technical Specification
# Overview
diff --git a/hw/ip/uart/doc/checklist.md b/hw/ip/uart/doc/checklist.md
index 2451235..0b8d0e1 100644
--- a/hw/ip/uart/doc/checklist.md
+++ b/hw/ip/uart/doc/checklist.md
@@ -1,6 +1,4 @@
----
-title: "UART Checklist"
----
+# UART Checklist
This checklist is for [Hardware Stage][] transitions for the [UART peripheral.](../README.md)
All checklist items refer to the content in the [Checklist.](../../../../doc/project_governance/checklist/README.md)
diff --git a/hw/ip/uart/dv/README.md b/hw/ip/uart/dv/README.md
index ded2d30..5e94242 100644
--- a/hw/ip/uart/dv/README.md
+++ b/hw/ip/uart/dv/README.md
@@ -1,6 +1,4 @@
----
-title: "UART DV document"
----
+# UART DV document
## Goals
diff --git a/hw/ip/usbdev/README.md b/hw/ip/usbdev/README.md
index 97293d0..03b8f18 100644
--- a/hw/ip/usbdev/README.md
+++ b/hw/ip/usbdev/README.md
@@ -1,6 +1,4 @@
----
-title: "USB 2.0 Full-Speed Device HWIP Technical Specification"
----
+# USB 2.0 Full-Speed Device HWIP Technical Specification
# Overview
diff --git a/hw/ip/usbdev/doc/checklist.md b/hw/ip/usbdev/doc/checklist.md
index 755ffe0..3c35ae6 100644
--- a/hw/ip/usbdev/doc/checklist.md
+++ b/hw/ip/usbdev/doc/checklist.md
@@ -1,6 +1,4 @@
----
-title: "USB Device Checklist"
----
+# USB Device Checklist
This checklist is for [Hardware Stage](../../../../doc/project_governance/development_stages.md) transitions for the [USB Device peripheral.](../README.md)
All checklist items refer to the content in the [Checklist.](../../../../doc/project_governance/checklist/README.md)
diff --git a/hw/ip/usbdev/doc/wake_resume.md b/hw/ip/usbdev/doc/wake_resume.md
index ebe9722..c151b59 100644
--- a/hw/ip/usbdev/doc/wake_resume.md
+++ b/hw/ip/usbdev/doc/wake_resume.md
@@ -1,6 +1,4 @@
----
-title: "USBDEV Suspending and Resuming with Sleep / Low Power Modes"
----
+# USBDEV Suspending and Resuming with Sleep / Low Power Modes
# Overview
diff --git a/hw/ip/usbdev/dv/README.md b/hw/ip/usbdev/dv/README.md
index 61341ea..415bd72 100644
--- a/hw/ip/usbdev/dv/README.md
+++ b/hw/ip/usbdev/dv/README.md
@@ -1,6 +1,4 @@
----
-title: "USBDEV DV document"
----
+# USBDEV DV document
## Goals
* **DV**
diff --git a/hw/ip_templates/alert_handler/README.md b/hw/ip_templates/alert_handler/README.md
index a401258..b3fc596 100644
--- a/hw/ip_templates/alert_handler/README.md
+++ b/hw/ip_templates/alert_handler/README.md
@@ -1,6 +1,4 @@
----
-title: "Alert Handler Technical Specification"
----
+# Alert Handler Technical Specification
# Overview
diff --git a/hw/ip_templates/alert_handler/doc/checklist.md b/hw/ip_templates/alert_handler/doc/checklist.md
index 1e94ec1..3d3b7fe 100644
--- a/hw/ip_templates/alert_handler/doc/checklist.md
+++ b/hw/ip_templates/alert_handler/doc/checklist.md
@@ -1,6 +1,4 @@
----
-title: "Alert Handler Checklist"
----
+# Alert Handler Checklist
This checklist is for [Hardware Stage](../../../../doc/project_governance/development_stages.md) transitions for the [Alert Handler peripheral.](../README.md)
All checklist items refer to the content in the [Checklist.](../../../../doc/project_governance/checklist/README.md)
diff --git a/hw/ip_templates/alert_handler/dv/README.md b/hw/ip_templates/alert_handler/dv/README.md
index 030e367..818e799 100644
--- a/hw/ip_templates/alert_handler/dv/README.md
+++ b/hw/ip_templates/alert_handler/dv/README.md
@@ -1,6 +1,4 @@
----
-title: "ALERT_HANDLER DV document"
----
+# ALERT_HANDLER DV document
## Goals
* **DV**
diff --git a/hw/ip_templates/rv_plic/README.md b/hw/ip_templates/rv_plic/README.md
index b6939c4..40976b1 100644
--- a/hw/ip_templates/rv_plic/README.md
+++ b/hw/ip_templates/rv_plic/README.md
@@ -1,6 +1,4 @@
----
-title: "Interrupt Controller Technical Specification"
----
+# Interrupt Controller Technical Specification
# Overview
diff --git a/hw/ip_templates/rv_plic/doc/checklist.md b/hw/ip_templates/rv_plic/doc/checklist.md
index cf796d1..2095ed8 100644
--- a/hw/ip_templates/rv_plic/doc/checklist.md
+++ b/hw/ip_templates/rv_plic/doc/checklist.md
@@ -1,6 +1,4 @@
----
-title: "RV_PLIC Checklist"
----
+# RV_PLIC Checklist
This checklist is for [Hardware Stage](../../../../doc/project_governance/development_stages.md) transitions for the [RV_PLIC peripheral](../README.md).
All checklist items refer to the content in the [Checklist.](../../../../doc/project_governance/checklist/README.md)
diff --git a/hw/ip_templates/rv_plic/doc/dv/README.md b/hw/ip_templates/rv_plic/doc/dv/README.md
index b7cfb53..a09ff06 100644
--- a/hw/ip_templates/rv_plic/doc/dv/README.md
+++ b/hw/ip_templates/rv_plic/doc/dv/README.md
@@ -1,6 +1,4 @@
----
-title: "RV_PLIC DV document"
----
+# RV_PLIC DV document
## Goals
* DV:
diff --git a/hw/lint/README.md b/hw/lint/README.md
index 2c3ae82..21fe0df 100644
--- a/hw/lint/README.md
+++ b/hw/lint/README.md
@@ -1,7 +1,4 @@
----
-title: "Linting"
-unlisted: true
----
+# Linting
# RTL Linting
diff --git a/hw/top_earlgrey/README.md b/hw/top_earlgrey/README.md
index eb20a54..3c9e138 100644
--- a/hw/top_earlgrey/README.md
+++ b/hw/top_earlgrey/README.md
@@ -1,6 +1,4 @@
----
-title: "Top Earlgrey"
----
+# Top Earlgrey
## Specification
diff --git a/hw/top_earlgrey/doc/design/README.md b/hw/top_earlgrey/doc/design/README.md
index 3a8bf5b..8cb6fd2 100644
--- a/hw/top_earlgrey/doc/design/README.md
+++ b/hw/top_earlgrey/doc/design/README.md
@@ -1,6 +1,4 @@
----
-title: "OpenTitan Earl Grey Chip Specification"
----
+# OpenTitan Earl Grey Chip Specification
This document describes the OpenTitan Earl Grey chip functionality in detail.
For an overview, refer to the [OpenTitan Earl Grey Chip Datasheet](../specification.md).
diff --git a/hw/top_earlgrey/doc/specification.md b/hw/top_earlgrey/doc/specification.md
index 87ab36c..acdfa16 100644
--- a/hw/top_earlgrey/doc/specification.md
+++ b/hw/top_earlgrey/doc/specification.md
@@ -1,6 +1,4 @@
----
-title: "OpenTitan Earl Grey Chip Datasheet"
----
+# OpenTitan Earl Grey Chip Datasheet
# Overview
diff --git a/hw/top_earlgrey/dv/README.md b/hw/top_earlgrey/dv/README.md
index 9abfe58..f2cc305 100644
--- a/hw/top_earlgrey/dv/README.md
+++ b/hw/top_earlgrey/dv/README.md
@@ -1,6 +1,4 @@
----
-title: "OpenTitan Earl Grey Chip DV Document"
----
+# OpenTitan Earl Grey Chip DV Document
## Goals
* **DV**
diff --git a/hw/top_earlgrey/ip/ast/README.md b/hw/top_earlgrey/ip/ast/README.md
index 0f46750..07492dc 100644
--- a/hw/top_earlgrey/ip/ast/README.md
+++ b/hw/top_earlgrey/ip/ast/README.md
@@ -1,6 +1,4 @@
----
-title: "Analog Sensor Top Technical Specification"
----
+# Analog Sensor Top Technical Specification
# Overview
AST, also known as the analog sensor top, is the OpenTitan analog and
diff --git a/hw/top_earlgrey/ip/pinmux/doc/autogen/pinout_asic.md b/hw/top_earlgrey/ip/pinmux/doc/autogen/pinout_asic.md
index 7179441..a93fe16 100644
--- a/hw/top_earlgrey/ip/pinmux/doc/autogen/pinout_asic.md
+++ b/hw/top_earlgrey/ip/pinmux/doc/autogen/pinout_asic.md
@@ -1,6 +1,4 @@
----
-title: ASIC Target Pinout and Pinmux Connectivity
----
+# ASIC Target Pinout and Pinmux Connectivity
<!--
DO NOT EDIT THIS FILE DIRECTLY.
It has been generated with the following command:
diff --git a/hw/top_earlgrey/ip/pinmux/doc/autogen/pinout_cw310.md b/hw/top_earlgrey/ip/pinmux/doc/autogen/pinout_cw310.md
index 82cc3e8..f735e29 100644
--- a/hw/top_earlgrey/ip/pinmux/doc/autogen/pinout_cw310.md
+++ b/hw/top_earlgrey/ip/pinmux/doc/autogen/pinout_cw310.md
@@ -1,6 +1,4 @@
----
-title: CW310 Target Pinout and Pinmux Connectivity
----
+# CW310 Target Pinout and Pinmux Connectivity
<!--
DO NOT EDIT THIS FILE DIRECTLY.
It has been generated with the following command:
diff --git a/hw/top_earlgrey/ip/sensor_ctrl/README.md b/hw/top_earlgrey/ip/sensor_ctrl/README.md
index ee28c19..55aa888 100644
--- a/hw/top_earlgrey/ip/sensor_ctrl/README.md
+++ b/hw/top_earlgrey/ip/sensor_ctrl/README.md
@@ -1,6 +1,4 @@
----
-title: "Sensor Control Technical Specification"
----
+# Sensor Control Technical Specification
# Overview
diff --git a/hw/top_earlgrey/ip/sensor_ctrl/doc/checklist.md b/hw/top_earlgrey/ip/sensor_ctrl/doc/checklist.md
index 88c829a..9a8ea16 100644
--- a/hw/top_earlgrey/ip/sensor_ctrl/doc/checklist.md
+++ b/hw/top_earlgrey/ip/sensor_ctrl/doc/checklist.md
@@ -1,6 +1,4 @@
----
-title: "SENSOR_CTRL Checklist"
----
+# SENSOR_CTRL Checklist
This checklist is for [Hardware Stage](../../../../../doc/project_governance/development_stages.md) transitions for the [SENSOR_CTRL peripheral.](../README.md)
All checklist items refer to the content in the [Checklist.](../../../../../doc/project_governance/checklist/README.md)
diff --git a/hw/top_earlgrey/ip/xbar/doc/checklist.md b/hw/top_earlgrey/ip/xbar/doc/checklist.md
index b14bc7a..6019333 100644
--- a/hw/top_earlgrey/ip/xbar/doc/checklist.md
+++ b/hw/top_earlgrey/ip/xbar/doc/checklist.md
@@ -1,6 +1,4 @@
----
-title: "TL-UL Checklist"
----
+# TL-UL Checklist
This checklist is for [Hardware Stage](../../../../../doc/project_governance/development_stages.md) transitions for the [TL-UL component.](../../../../ip/tlul/README.md)
All checklist items refer to the content in the [Checklist](../../../../../doc/project_governance/checklist/README.md).
diff --git a/hw/top_earlgrey/ip_autogen/alert_handler/README.md b/hw/top_earlgrey/ip_autogen/alert_handler/README.md
index bd25c26..7384839 100644
--- a/hw/top_earlgrey/ip_autogen/alert_handler/README.md
+++ b/hw/top_earlgrey/ip_autogen/alert_handler/README.md
@@ -1,6 +1,4 @@
----
-title: "Alert Handler Technical Specification"
----
+# Alert Handler Technical Specification
# Overview
diff --git a/hw/top_earlgrey/ip_autogen/alert_handler/doc/checklist.md b/hw/top_earlgrey/ip_autogen/alert_handler/doc/checklist.md
index cede5ba..bdc3192 100644
--- a/hw/top_earlgrey/ip_autogen/alert_handler/doc/checklist.md
+++ b/hw/top_earlgrey/ip_autogen/alert_handler/doc/checklist.md
@@ -1,6 +1,4 @@
----
-title: "Alert Handler Checklist"
----
+# Alert Handler Checklist
This checklist is for [Hardware Stage](../../../../../doc/project_governance/development_stages.md) transitions for the [Alert Handler peripheral.](../README.md)
All checklist items refer to the content in the [Checklist.](../../../../../doc/project_governance/checklist/README.md)
diff --git a/hw/top_earlgrey/ip_autogen/alert_handler/dv/README.md b/hw/top_earlgrey/ip_autogen/alert_handler/dv/README.md
index 577731c..04f07d3 100644
--- a/hw/top_earlgrey/ip_autogen/alert_handler/dv/README.md
+++ b/hw/top_earlgrey/ip_autogen/alert_handler/dv/README.md
@@ -1,6 +1,4 @@
----
-title: "ALERT_HANDLER DV document"
----
+# ALERT_HANDLER DV document
## Goals
* **DV**
diff --git a/hw/top_earlgrey/ip_autogen/rv_plic/README.md b/hw/top_earlgrey/ip_autogen/rv_plic/README.md
index b7b2011..ab88c37 100644
--- a/hw/top_earlgrey/ip_autogen/rv_plic/README.md
+++ b/hw/top_earlgrey/ip_autogen/rv_plic/README.md
@@ -1,6 +1,4 @@
----
-title: "Interrupt Controller Technical Specification"
----
+# Interrupt Controller Technical Specification
# Overview
diff --git a/hw/top_earlgrey/ip_autogen/rv_plic/doc/checklist.md b/hw/top_earlgrey/ip_autogen/rv_plic/doc/checklist.md
index 0a31427..0fe1557 100644
--- a/hw/top_earlgrey/ip_autogen/rv_plic/doc/checklist.md
+++ b/hw/top_earlgrey/ip_autogen/rv_plic/doc/checklist.md
@@ -1,6 +1,4 @@
----
-title: "RV_PLIC Checklist"
----
+# RV_PLIC Checklist
This checklist is for [Hardware Stage](../../../../../doc/project_governance/development_stages.md) transitions for the [RV_PLIC peripheral](../README.md).
All checklist items refer to the content in the [Checklist.](../../../../../doc/project_governance/checklist/README.md)
diff --git a/hw/top_earlgrey/ip_autogen/rv_plic/doc/dv/README.md b/hw/top_earlgrey/ip_autogen/rv_plic/doc/dv/README.md
index 4f79dc3..9422726 100644
--- a/hw/top_earlgrey/ip_autogen/rv_plic/doc/dv/README.md
+++ b/hw/top_earlgrey/ip_autogen/rv_plic/doc/dv/README.md
@@ -1,6 +1,4 @@
----
-title: "RV_PLIC DV document"
----
+# RV_PLIC DV document
## Goals
* DV:
diff --git a/site/docs/doxygen/main_page.md b/site/docs/doxygen/main_page.md
index d44cb92..0bddaf3 100644
--- a/site/docs/doxygen/main_page.md
+++ b/site/docs/doxygen/main_page.md
@@ -8,4 +8,4 @@
[Return to OpenTitan Software Documentation](../README.md)
-[Return to OpenTitan Documentation](../..)
\ No newline at end of file
+[Return to OpenTitan Documentation](../..)
diff --git a/sw/README.md b/sw/README.md
index 7329bf1..d590900 100644
--- a/sw/README.md
+++ b/sw/README.md
@@ -1,6 +1,4 @@
----
-title: "Software"
----
+# Software
This is the landing spot for software documentation within the OpenTitan project.
More description and information can be found within the [Reference Manual](../util/README.md) and [User Guide](https://docs.opentitan.org/doc/guides/getting_started/) areas.
diff --git a/sw/device/README.md b/sw/device/README.md
index b152f68..3f9fb54 100644
--- a/sw/device/README.md
+++ b/sw/device/README.md
@@ -1,6 +1,4 @@
----
-title: "Device Software"
----
+# Device Software
## Reference Firmware Images
diff --git a/sw/device/lib/README.md b/sw/device/lib/README.md
index 81292f8..16e046d 100644
--- a/sw/device/lib/README.md
+++ b/sw/device/lib/README.md
@@ -1,6 +1,4 @@
----
-title: "Device Libraries"
----
+# Device Libraries
## Overview
diff --git a/sw/device/lib/dif/README.md b/sw/device/lib/dif/README.md
index 95290c1..e340677 100644
--- a/sw/device/lib/dif/README.md
+++ b/sw/device/lib/dif/README.md
@@ -1,6 +1,4 @@
----
-title: "The OpenTitan DIF Library"
----
+# The OpenTitan DIF Library
A DIF is a "Device Interface Function". DIFs are low-level routines for
accessing the hardware functionality directly, and are agnostic to the
diff --git a/sw/device/lib/dif/dif_adc_ctrl.md b/sw/device/lib/dif/dif_adc_ctrl.md
index 91a3930..8802dc7 100644
--- a/sw/device/lib/dif/dif_adc_ctrl.md
+++ b/sw/device/lib/dif/dif_adc_ctrl.md
@@ -1,6 +1,4 @@
----
-title: "ADC Controller DIF Checklist"
----
+# ADC Controller DIF Checklist
This checklist is for [Development Stage](../../../../doc/project_governance/development_stages.md) transitions for the [ADC Controller DIF](../../../../hw/ip/adc_ctrl/README.md).
All checklist items refer to the content in the [Checklist](../../../../doc/project_governance/checklist/README.md).
diff --git a/sw/device/lib/dif/dif_aes.md b/sw/device/lib/dif/dif_aes.md
index de291ed..d8b2a51 100644
--- a/sw/device/lib/dif/dif_aes.md
+++ b/sw/device/lib/dif/dif_aes.md
@@ -1,6 +1,4 @@
----
-title: "AES DIF Checklist"
----
+# AES DIF Checklist
This checklist is for [Development Stage](../../../../doc/project_governance/development_stages.md) transitions for the [AES DIF](../../../../hw/ip/aes/README.md).
All checklist items refer to the content in the [Checklist](../../../../doc/project_governance/checklist/README.md).
diff --git a/sw/device/lib/dif/dif_alert_handler.md b/sw/device/lib/dif/dif_alert_handler.md
index f48daeb..b71301b 100644
--- a/sw/device/lib/dif/dif_alert_handler.md
+++ b/sw/device/lib/dif/dif_alert_handler.md
@@ -1,6 +1,4 @@
----
-title: "Alert Handler DIF Checklist"
----
+# Alert Handler DIF Checklist
This checklist is for [Development Stage](../../../../doc/project_governance/development_stages.md) transitions for the [Alert Handler DIF](../../../../hw/top_earlgrey/ip_autogen/alert_handler/README.md).
All checklist items refer to the content in the [Checklist](../../../../doc/project_governance/checklist/README.md).
diff --git a/sw/device/lib/dif/dif_aon_timer.md b/sw/device/lib/dif/dif_aon_timer.md
index ad368e4..f1331c8 100644
--- a/sw/device/lib/dif/dif_aon_timer.md
+++ b/sw/device/lib/dif/dif_aon_timer.md
@@ -1,6 +1,4 @@
----
-title: "Always-On Timer DIF Checklist"
----
+# Always-On Timer DIF Checklist
This checklist is for [Development Stage](../../../../doc/project_governance/development_stages.md) transitions for the [Always-On Timer DIF](../../../../hw/ip/aon_timer/README.md).
All checklist items refer to the content in the [Checklist](../../../../doc/project_governance/checklist/README.md).
diff --git a/sw/device/lib/dif/dif_clkmgr.md b/sw/device/lib/dif/dif_clkmgr.md
index 6fb6346..b0e01de 100644
--- a/sw/device/lib/dif/dif_clkmgr.md
+++ b/sw/device/lib/dif/dif_clkmgr.md
@@ -1,6 +1,4 @@
----
-title: "Clock Manager DIF Checklist"
----
+# Clock Manager DIF Checklist
This checklist is for [Development Stage](../../../../doc/project_governance/development_stages.md) transitions for the [Clock Manager DIF](../../../../hw/ip/clkmgr/README.md).
All checklist items refer to the content in the [Checklist](../../../../doc/project_governance/checklist/README.md).
diff --git a/sw/device/lib/dif/dif_csrng.md b/sw/device/lib/dif/dif_csrng.md
index 650e082..4c887bb 100644
--- a/sw/device/lib/dif/dif_csrng.md
+++ b/sw/device/lib/dif/dif_csrng.md
@@ -1,6 +1,4 @@
----
-title: "CSRNG DIF Checklist"
----
+# CSRNG DIF Checklist
This checklist is for [Development Stage](../../../../doc/project_governance/development_stages.md) transitions for the [CSRNG DIF](../../../../hw/ip/csrng/README.md).
All checklist items refer to the content in the [Checklist](../../../../doc/project_governance/checklist/README.md).
diff --git a/sw/device/lib/dif/dif_edn.md b/sw/device/lib/dif/dif_edn.md
index 09867a1..2fb6e96 100644
--- a/sw/device/lib/dif/dif_edn.md
+++ b/sw/device/lib/dif/dif_edn.md
@@ -1,6 +1,4 @@
----
-title: "Entropy Distribution Network DIF Checklist"
----
+# Entropy Distribution Network DIF Checklist
This checklist is for [Development Stage](../../../../doc/project_governance/development_stages.md) transitions for the [Entropy Distribution Network DIF](../../../../hw/ip/edn/README.md).
All checklist items refer to the content in the [Checklist](../../../../doc/project_governance/checklist/README.md).
diff --git a/sw/device/lib/dif/dif_entropy_src.md b/sw/device/lib/dif/dif_entropy_src.md
index 1367d88..afedf37 100644
--- a/sw/device/lib/dif/dif_entropy_src.md
+++ b/sw/device/lib/dif/dif_entropy_src.md
@@ -1,6 +1,4 @@
----
-title: "Entropy Source DIF Checklist"
----
+# Entropy Source DIF Checklist
This checklist is for [Development Stage](../../../../doc/project_governance/development_stages.md) transitions for the [Entropy Source DIF](../../../../hw/ip/entropy_src/README.md).
All checklist items refer to the content in the [Checklist](../../../../doc/project_governance/checklist/README.md).
diff --git a/sw/device/lib/dif/dif_flash_ctrl.md b/sw/device/lib/dif/dif_flash_ctrl.md
index 0cd8da2..362fff1 100644
--- a/sw/device/lib/dif/dif_flash_ctrl.md
+++ b/sw/device/lib/dif/dif_flash_ctrl.md
@@ -1,6 +1,4 @@
----
-title: "Flash Controller DIF Checklist"
----
+# Flash Controller DIF Checklist
This checklist is for [Development Stage](../../../../doc/project_governance/development_stages.md) transitions for the [Flash Controller DIF](../../../../hw/ip/flash_ctrl/README.md).
All checklist items refer to the content in the [Checklist](../../../../doc/project_governance/checklist/README.md).
diff --git a/sw/device/lib/dif/dif_gpio.md b/sw/device/lib/dif/dif_gpio.md
index d023030..588e691 100644
--- a/sw/device/lib/dif/dif_gpio.md
+++ b/sw/device/lib/dif/dif_gpio.md
@@ -1,6 +1,4 @@
----
-title: "GPIO DIF Checklist"
----
+# GPIO DIF Checklist
This checklist is for [Development Stage](../../../../doc/project_governance/development_stages.md) transitions for the [GPIO DIF](../../../../hw/ip/gpio/README.md).
All checklist items refer to the content in the [Checklist](../../../../doc/project_governance/checklist/README.md).
diff --git a/sw/device/lib/dif/dif_hmac.md b/sw/device/lib/dif/dif_hmac.md
index 6b0480e..2fe9661 100644
--- a/sw/device/lib/dif/dif_hmac.md
+++ b/sw/device/lib/dif/dif_hmac.md
@@ -1,6 +1,4 @@
----
-title: "HMAC DIF Checklist"
----
+# HMAC DIF Checklist
This checklist is for [Development Stage](../../../../doc/project_governance/development_stages.md) transitions for the [HMAC DIF](../../../../hw/ip/hmac/README.md).
All checklist items refer to the content in the [Checklist](../../../../doc/project_governance/checklist/README.md).
diff --git a/sw/device/lib/dif/dif_i2c.md b/sw/device/lib/dif/dif_i2c.md
index 8977800..6181bf1 100644
--- a/sw/device/lib/dif/dif_i2c.md
+++ b/sw/device/lib/dif/dif_i2c.md
@@ -1,6 +1,4 @@
----
-title: "I2C DIF Checklist"
----
+# I2C DIF Checklist
This checklist is for [Development Stage](../../../../doc/project_governance/development_stages.md) transitions for the [I2C DIF](../../../../hw/ip/i2c/README.md).
All checklist items refer to the content in the [Checklist](../../../../doc/project_governance/checklist/README.md).
diff --git a/sw/device/lib/dif/dif_keymgr.md b/sw/device/lib/dif/dif_keymgr.md
index af93d25..625af17 100644
--- a/sw/device/lib/dif/dif_keymgr.md
+++ b/sw/device/lib/dif/dif_keymgr.md
@@ -1,6 +1,4 @@
----
-title: "Key Manager DIF Checklist"
----
+# Key Manager DIF Checklist
This checklist is for [Development Stage](../../../../doc/project_governance/development_stages.md) transitions for the [Key Manager DIF](../../../../hw/ip/keymgr/README.md).
All checklist items refer to the content in the [Checklist](../../../../doc/project_governance/checklist/README.md).
diff --git a/sw/device/lib/dif/dif_kmac.md b/sw/device/lib/dif/dif_kmac.md
index 12cacfb..99dad27 100644
--- a/sw/device/lib/dif/dif_kmac.md
+++ b/sw/device/lib/dif/dif_kmac.md
@@ -1,6 +1,4 @@
----
-title: "KMAC DIF Checklist"
----
+# KMAC DIF Checklist
This checklist is for [Development Stage](../../../../doc/project_governance/development_stages.md) transitions for the [KMAC DIF](../../../../hw/ip/kmac/README.md).
All checklist items refer to the content in the [Checklist](../../../../doc/project_governance/checklist/README.md).
diff --git a/sw/device/lib/dif/dif_lc_ctrl.md b/sw/device/lib/dif/dif_lc_ctrl.md
index 4ede965..84ed4aa 100644
--- a/sw/device/lib/dif/dif_lc_ctrl.md
+++ b/sw/device/lib/dif/dif_lc_ctrl.md
@@ -1,6 +1,4 @@
----
-title: "Lifecycle Controller DIF Checklist"
----
+# Lifecycle Controller DIF Checklist
This checklist is for [Development Stage](../../../../doc/project_governance/development_stages.md) transitions for the [Lifecycle Controller DIF](../../../../hw/ip/lc_ctrl/README.md).
All checklist items refer to the content in the [Checklist](../../../../doc/project_governance/checklist/README.md).
diff --git a/sw/device/lib/dif/dif_otbn.md b/sw/device/lib/dif/dif_otbn.md
index 0093c6f..f627e1f 100644
--- a/sw/device/lib/dif/dif_otbn.md
+++ b/sw/device/lib/dif/dif_otbn.md
@@ -1,6 +1,4 @@
----
-title: "OTBN DIF Checklist"
----
+# OTBN DIF Checklist
This checklist is for [Development Stage](../../../../doc/project_governance/development_stages.md) transitions for the [OTBN DIF](../../../../hw/ip/otbn/README.md).
All checklist items refer to the content in the [Checklist](../../../../doc/project_governance/checklist/README.md).
diff --git a/sw/device/lib/dif/dif_otp_ctrl.md b/sw/device/lib/dif/dif_otp_ctrl.md
index 51ce7f3..4a2b2cd 100644
--- a/sw/device/lib/dif/dif_otp_ctrl.md
+++ b/sw/device/lib/dif/dif_otp_ctrl.md
@@ -1,6 +1,4 @@
----
-title: "OTP Controller DIF Checklist"
----
+# OTP Controller DIF Checklist
This checklist is for [Development Stage](../../../../doc/project_governance/development_stages.md) transitions for the [OTP Controller DIF](../../../../hw/ip/otp_ctrl/README.md).
All checklist items refer to the content in the [Checklist](../../../../doc/project_governance/checklist/README.md).
diff --git a/sw/device/lib/dif/dif_pattgen.md b/sw/device/lib/dif/dif_pattgen.md
index 3f74bc4..75b219f 100644
--- a/sw/device/lib/dif/dif_pattgen.md
+++ b/sw/device/lib/dif/dif_pattgen.md
@@ -1,6 +1,4 @@
----
-title: "Pattern Generator DIF Checklist"
----
+# Pattern Generator DIF Checklist
This checklist is for [Development Stage](../../../../doc/project_governance/development_stages.md) transitions for the [Pattern Generator DIF](../../../../hw/ip/pattgen/README.md).
All checklist items refer to the content in the [Checklist](../../../../doc/project_governance/checklist/README.md).
diff --git a/sw/device/lib/dif/dif_pinmux.md b/sw/device/lib/dif/dif_pinmux.md
index 6440f06..b4746b9 100644
--- a/sw/device/lib/dif/dif_pinmux.md
+++ b/sw/device/lib/dif/dif_pinmux.md
@@ -1,6 +1,4 @@
----
-title: "Pin Multiplexer DIF Checklist"
----
+# Pin Multiplexer DIF Checklist
This checklist is for [Development Stage](../../../../doc/project_governance/development_stages.md) transitions for the [Pin Multiplexer DIF](../../../../hw/ip/pinmux/README.md).
All checklist items refer to the content in the [Checklist](../../../../doc/project_governance/checklist/README.md).
diff --git a/sw/device/lib/dif/dif_pwm.md b/sw/device/lib/dif/dif_pwm.md
index f911d0b..606cec4 100644
--- a/sw/device/lib/dif/dif_pwm.md
+++ b/sw/device/lib/dif/dif_pwm.md
@@ -1,6 +1,4 @@
----
-title: "PWM DIF Checklist"
----
+# PWM DIF Checklist
This checklist is for [Development Stage](../../../../doc/project_governance/development_stages.md) transitions for the [PWM DIF](../../../../hw/ip/pwm/README.md).
All checklist items refer to the content in the [Checklist](../../../../doc/project_governance/checklist/README.md).
diff --git a/sw/device/lib/dif/dif_pwrmgr.md b/sw/device/lib/dif/dif_pwrmgr.md
index 51b60df..1828c86 100644
--- a/sw/device/lib/dif/dif_pwrmgr.md
+++ b/sw/device/lib/dif/dif_pwrmgr.md
@@ -1,6 +1,4 @@
----
-title: "Power Manager DIF Checklist"
----
+# Power Manager DIF Checklist
This checklist is for [Development Stage](../../../../doc/project_governance/development_stages.md) transitions for the [Power Manager DIF](../../../../hw/ip/pwrmgr/README.md).
All checklist items refer to the content in the [Checklist](../../../../doc/project_governance/checklist/README.md).
diff --git a/sw/device/lib/dif/dif_rom_ctrl.md b/sw/device/lib/dif/dif_rom_ctrl.md
index e585d7f..bb75af5 100644
--- a/sw/device/lib/dif/dif_rom_ctrl.md
+++ b/sw/device/lib/dif/dif_rom_ctrl.md
@@ -1,6 +1,4 @@
----
-title: "ROM Controller DIF Checklist"
----
+# ROM Controller DIF Checklist
This checklist is for [Development Stage](../../../../doc/project_governance/development_stages.md) transitions for the [ROM Controller DIF](../../../../hw/ip/rom_ctrl/README.md).
All checklist items refer to the content in the [Checklist](../../../../doc/project_governance/checklist/README.md).
diff --git a/sw/device/lib/dif/dif_rstmgr.md b/sw/device/lib/dif/dif_rstmgr.md
index d58ddda..1e7a0ef 100644
--- a/sw/device/lib/dif/dif_rstmgr.md
+++ b/sw/device/lib/dif/dif_rstmgr.md
@@ -1,6 +1,4 @@
----
-title: "Reset Manager DIF Checklist"
----
+# Reset Manager DIF Checklist
This checklist is for [Development Stage](../../../../doc/project_governance/development_stages.md) transitions for the [Reset Manager DIF](../../../../hw/ip/rstmgr/README.md).
All checklist items refer to the content in the [Checklist](../../../../doc/project_governance/checklist/README.md).
diff --git a/sw/device/lib/dif/dif_rv_core_ibex.md b/sw/device/lib/dif/dif_rv_core_ibex.md
index d8d3b22..72666c8 100644
--- a/sw/device/lib/dif/dif_rv_core_ibex.md
+++ b/sw/device/lib/dif/dif_rv_core_ibex.md
@@ -1,6 +1,4 @@
----
-title: "Rv core ibex DIF Checklist"
----
+# Rv core ibex DIF Checklist
This checklist is for [Development Stage](../../../../doc/project_governance/development_stages.md) transitions for the [Rv core ibex DIF](../../../../hw/ip/rv_core_ibex/README.md).
All checklist items refer to the content in the [Checklist](../../../../doc/project_governance/checklist/README.md).
diff --git a/sw/device/lib/dif/dif_rv_plic.md b/sw/device/lib/dif/dif_rv_plic.md
index 3923d29..9ebad2a 100644
--- a/sw/device/lib/dif/dif_rv_plic.md
+++ b/sw/device/lib/dif/dif_rv_plic.md
@@ -1,6 +1,4 @@
----
-title: "PLIC DIF Checklist"
----
+# PLIC DIF Checklist
This checklist is for [Development Stage](../../../../doc/project_governance/development_stages.md) transitions for the [PLIC DIF](../../../../hw/top_earlgrey/ip_autogen/rv_plic/README.md).
All checklist items refer to the content in the [Checklist](../../../../doc/project_governance/checklist/README.md).
diff --git a/sw/device/lib/dif/dif_rv_timer.md b/sw/device/lib/dif/dif_rv_timer.md
index d527ad4..17a3d4a 100644
--- a/sw/device/lib/dif/dif_rv_timer.md
+++ b/sw/device/lib/dif/dif_rv_timer.md
@@ -1,6 +1,4 @@
----
-title: "RV Timer DIF Checklist"
----
+# RV Timer DIF Checklist
This checklist is for [Development Stage](../../../../doc/project_governance/development_stages.md) transitions for the [RV Timer DIF](../../../../hw/ip/rv_timer/README.md).
All checklist items refer to the content in the [Checklist](../../../../doc/project_governance/checklist/README.md).
diff --git a/sw/device/lib/dif/dif_sensor_ctrl.md b/sw/device/lib/dif/dif_sensor_ctrl.md
index 0aaf497..601eb0e 100644
--- a/sw/device/lib/dif/dif_sensor_ctrl.md
+++ b/sw/device/lib/dif/dif_sensor_ctrl.md
@@ -1,6 +1,4 @@
----
-title: "Sensor Controller DIF Checklist"
----
+# Sensor Controller DIF Checklist
This checklist is for [Development Stage](../../../../doc/project_governance/development_stages.md) transitions for the [Sensor Controller DIF](../../../../hw/top_earlgrey/ip/sensor_ctrl/README.md).
All checklist items refer to the content in the [Checklist](../../../../doc/project_governance/checklist/README.md).
diff --git a/sw/device/lib/dif/dif_spi_device.md b/sw/device/lib/dif/dif_spi_device.md
index 3a6d07a..f064da5 100644
--- a/sw/device/lib/dif/dif_spi_device.md
+++ b/sw/device/lib/dif/dif_spi_device.md
@@ -1,6 +1,4 @@
----
-title: "SPI Device DIF Checklist"
----
+# SPI Device DIF Checklist
This checklist is for [Development Stage](../../../../doc/project_governance/development_stages.md) transitions for the [SPI Device DIF](../../../../hw/ip/spi_device/README.md).
All checklist items refer to the content in the [Checklist](../../../../doc/project_governance/checklist/README.md).
diff --git a/sw/device/lib/dif/dif_spi_host.md b/sw/device/lib/dif/dif_spi_host.md
index d1f4429..dc40c06 100644
--- a/sw/device/lib/dif/dif_spi_host.md
+++ b/sw/device/lib/dif/dif_spi_host.md
@@ -1,6 +1,4 @@
----
-title: "SPI Host DIF Checklist"
----
+# SPI Host DIF Checklist
This checklist is for [Development Stage](../../../../doc/project_governance/development_stages.md) transitions for the [SPI Host DIF](../../../../hw/ip/spi_host/README.md).
All checklist items refer to the content in the [Checklist](../../../../doc/project_governance/checklist/README.md).
diff --git a/sw/device/lib/dif/dif_sram_ctrl.md b/sw/device/lib/dif/dif_sram_ctrl.md
index 2bf014d..728045e 100644
--- a/sw/device/lib/dif/dif_sram_ctrl.md
+++ b/sw/device/lib/dif/dif_sram_ctrl.md
@@ -1,6 +1,4 @@
----
-title: "SRAM Controller DIF Checklist"
----
+# SRAM Controller DIF Checklist
This checklist is for [Development Stage](../../../../doc/project_governance/development_stages.md) transitions for the [SRAM Controller DIF](../../../../hw/ip/sram_ctrl/README.md).
All checklist items refer to the content in the [Checklist](../../../../doc/project_governance/checklist/README.md).
diff --git a/sw/device/lib/dif/dif_sysrst_ctrl.md b/sw/device/lib/dif/dif_sysrst_ctrl.md
index 51e70ad..fc6a490 100644
--- a/sw/device/lib/dif/dif_sysrst_ctrl.md
+++ b/sw/device/lib/dif/dif_sysrst_ctrl.md
@@ -1,6 +1,4 @@
----
-title: "System Reset Controller DIF Checklist"
----
+# System Reset Controller DIF Checklist
This checklist is for [Development Stage](../../../../doc/project_governance/development_stages.md) transitions for the [System Reset Controller DIF](../../../../hw/ip/sysrst_ctrl/README.md).
All checklist items refer to the content in the [Checklist](../../../../doc/project_governance/checklist/README.md).
diff --git a/sw/device/lib/dif/dif_uart.md b/sw/device/lib/dif/dif_uart.md
index 612f689..92ed03e 100644
--- a/sw/device/lib/dif/dif_uart.md
+++ b/sw/device/lib/dif/dif_uart.md
@@ -1,6 +1,4 @@
----
-title: "UART DIF Checklist"
----
+# UART DIF Checklist
This checklist is for [Development Stage](../../../../doc/project_governance/development_stages.md) transitions for the [UART DIF](../../../../hw/ip/uart/README.md).
All checklist items refer to the content in the [Checklist](../../../../doc/project_governance/checklist/README.md).
diff --git a/sw/device/lib/dif/dif_usbdev.md b/sw/device/lib/dif/dif_usbdev.md
index 7910277..0e5f851 100644
--- a/sw/device/lib/dif/dif_usbdev.md
+++ b/sw/device/lib/dif/dif_usbdev.md
@@ -1,6 +1,4 @@
----
-title: "USB Device DIF Checklist"
----
+# USB Device DIF Checklist
This checklist is for [Development Stage](../../../../doc/project_governance/development_stages.md) transitions for the [USB Device DIF](../../../../hw/ip/usbdev/README.md).
All checklist items refer to the content in the [Checklist](../../../../doc/project_governance/checklist/README.md).
diff --git a/sw/device/lib/testing/README.md b/sw/device/lib/testing/README.md
index 65e3d49..1d041e6 100644
--- a/sw/device/lib/testing/README.md
+++ b/sw/device/lib/testing/README.md
@@ -1,6 +1,4 @@
----
-title: "Chip-Level Test Libraries"
----
+# Chip-Level Test Libraries
# Overview
diff --git a/sw/device/lib/testing/test_framework/README.md b/sw/device/lib/testing/test_framework/README.md
index 754cf78..79e5514 100644
--- a/sw/device/lib/testing/test_framework/README.md
+++ b/sw/device/lib/testing/test_framework/README.md
@@ -1,6 +1,4 @@
----
-title: "On-Device Test Framework"
----
+# On-Device Test Framework
# Overview
diff --git a/sw/device/silicon_creator/README.md b/sw/device/silicon_creator/README.md
index 9b1d0e5..180eae3 100644
--- a/sw/device/silicon_creator/README.md
+++ b/sw/device/silicon_creator/README.md
@@ -1,6 +1,4 @@
----
-title: "Silicon Creator Software"
----
+# Silicon Creator Software
## Documentation Index
diff --git a/sw/device/silicon_creator/manuf/README.md b/sw/device/silicon_creator/manuf/README.md
index 3f71192..24e4129 100644
--- a/sw/device/silicon_creator/manuf/README.md
+++ b/sw/device/silicon_creator/manuf/README.md
@@ -1,6 +1,4 @@
----
-title: Manufacturing Firmware
----
+# Manufacturing Firmware
## Testplan
diff --git a/sw/device/silicon_creator/rom/README.md b/sw/device/silicon_creator/rom/README.md
index 394e740..b38de3d 100644
--- a/sw/device/silicon_creator/rom/README.md
+++ b/sw/device/silicon_creator/rom/README.md
@@ -1,6 +1,4 @@
----
-title: "ROM"
----
+# ROM
<p style="color: red; text-align: right;">
Status: Draft
diff --git a/sw/device/silicon_creator/rom/doc/memory_protection.md b/sw/device/silicon_creator/rom/doc/memory_protection.md
index dade04a..1787a2a 100644
--- a/sw/device/silicon_creator/rom/doc/memory_protection.md
+++ b/sw/device/silicon_creator/rom/doc/memory_protection.md
@@ -1,6 +1,4 @@
----
-title: "Memory Protection Module"
----
+# Memory Protection Module
<p style="color: red; text-align: right;">
Status: Draft
diff --git a/sw/device/silicon_creator/rom/keys/README.md b/sw/device/silicon_creator/rom/keys/README.md
index 80f0599..eb28980 100644
--- a/sw/device/silicon_creator/rom/keys/README.md
+++ b/sw/device/silicon_creator/rom/keys/README.md
@@ -1,6 +1,4 @@
----
-title: "Signing Keys"
----
+# Signing Keys
This directory contains ASN1 DER encoded development keys for signing ROM\_EXT
images. Until we have a more ergonomic tool for working with keys and signatures,
diff --git a/sw/device/silicon_creator/rom_ext/doc/manifest.md b/sw/device/silicon_creator/rom_ext/doc/manifest.md
index 489df9f..12958f2 100644
--- a/sw/device/silicon_creator/rom_ext/doc/manifest.md
+++ b/sw/device/silicon_creator/rom_ext/doc/manifest.md
@@ -1,8 +1,4 @@
----
-title: Manifest Format
-aliases:
-- /sw/device/silicon_creator/manifest
----
+# Manifest Format
<p style="color: red; text-align: right;">
Status: Draft
diff --git a/sw/device/tests/README.md b/sw/device/tests/README.md
index c378b60..9dd98f1 100644
--- a/sw/device/tests/README.md
+++ b/sw/device/tests/README.md
@@ -1,6 +1,4 @@
----
-title: "Chip-Level Tests"
----
+# Chip-Level Tests
# Overview
diff --git a/sw/doc/build_software.md b/sw/doc/build_software.md
index 062fe66..e47e18a 100644
--- a/sw/doc/build_software.md
+++ b/sw/doc/build_software.md
@@ -1,6 +1,4 @@
----
-title: "OpenTitan Software Build Instructions"
----
+# OpenTitan Software Build Instructions
All OpenTitan software is built with [Bazel](https://bazel.build/).
diff --git a/sw/host/README.md b/sw/host/README.md
index cec9baf..3372622 100644
--- a/sw/host/README.md
+++ b/sw/host/README.md
@@ -1,5 +1,3 @@
----
-title: "Host Software"
----
+# Host Software
**TODO**
diff --git a/sw/otbn/code-snippets/README.md b/sw/otbn/code-snippets/README.md
index 4043a0f..353f805 100644
--- a/sw/otbn/code-snippets/README.md
+++ b/sw/otbn/code-snippets/README.md
@@ -1,6 +1,4 @@
----
-title: "OTBN Code Snippets"
----
+# OTBN Code Snippets
This directory contains some code snippets that give examples of how
to do various tasks in OTBN code.
diff --git a/third_party/coremark/README.md b/third_party/coremark/README.md
index 33899c5..02ca9ad 100644
--- a/third_party/coremark/README.md
+++ b/third_party/coremark/README.md
@@ -1,6 +1,4 @@
----
-title: "CoreMark Benchmark"
----
+# CoreMark Benchmark
## Running CoreMark
diff --git a/util/README.md b/util/README.md
index 756fe4a..7463645 100644
--- a/util/README.md
+++ b/util/README.md
@@ -1,6 +1,4 @@
----
-title: "Reference Manuals"
----
+# Reference Manuals
* [Comportability Definition and Specification](../doc/contributing/hw/comportability/README.md)
* [Device Interface Function (DIF) Specification](../doc/contributing/sw/device_interface_functions.md)
diff --git a/util/doc/vendor.md b/util/doc/vendor.md
index 255a767..fa7d150 100644
--- a/util/doc/vendor.md
+++ b/util/doc/vendor.md
@@ -1,6 +1,4 @@
----
-title: "util/vendor.py: Vendor-in Components"
----
+# util/vendor.py: Vendor-in Components
Not all code contained in this repository is actually developed within this repository.
Code which we include from external sources is placed in `vendor` sub-directories (e.g. `hw/vendor`) and copied over from upstream sources.
diff --git a/util/dvsim/README.md b/util/dvsim/README.md
index 855130d..b2143b6 100644
--- a/util/dvsim/README.md
+++ b/util/dvsim/README.md
@@ -1,6 +1,4 @@
----
-title: "Testplanner tool"
----
+# Testplanner tool
`testplanner` is a Python based tool for parsing testplans written in Hjson format into a data structure that can be used for:
* Expanding the testplan inline within the DV document as a table;
diff --git a/util/dvsim/examples/testplanner/foo_dv_doc.md b/util/dvsim/examples/testplanner/foo_dv_doc.md
index a36daf9..0b59eab 100644
--- a/util/dvsim/examples/testplanner/foo_dv_doc.md
+++ b/util/dvsim/examples/testplanner/foo_dv_doc.md
@@ -1,7 +1,4 @@
----
-title: "FOO DV document"
-draft: true
----
+# FOO DV document
<!-- TODO: Remove "draft: true" from header before submitting -->
diff --git a/util/fpvgen/README.md b/util/fpvgen/README.md
index 550f9fc..9dbfe23 100644
--- a/util/fpvgen/README.md
+++ b/util/fpvgen/README.md
@@ -1,6 +1,4 @@
----
-title: "Fpvgen: Initial FPV testbench generation tool"
----
+# Fpvgen: Initial FPV testbench generation tool
# Overview
diff --git a/util/i2csvg/smbus/SMBus.md b/util/i2csvg/smbus/SMBus.md
index 3af3388..6e044bd 100644
--- a/util/i2csvg/smbus/SMBus.md
+++ b/util/i2csvg/smbus/SMBus.md
@@ -1,6 +1,4 @@
----
-title: Using I2C host for SMBus commands
----
+# Using I2C host for SMBus commands
The I2C host can generate all the SMBus commands listed in the Rev 3.0 SMBus specification.
diff --git a/util/ipgen/README.md b/util/ipgen/README.md
index fb36b9e..69e35a0 100644
--- a/util/ipgen/README.md
+++ b/util/ipgen/README.md
@@ -1,6 +1,4 @@
----
-title: "Ipgen: Generate IP blocks from IP templates"
----
+# Ipgen: Generate IP blocks from IP templates
Ipgen is a tool to produce IP blocks from IP templates.
diff --git a/util/reggen/README.md b/util/reggen/README.md
index e3b385e..1c84eab 100644
--- a/util/reggen/README.md
+++ b/util/reggen/README.md
@@ -1,6 +1,4 @@
----
-title: "Register Tool"
----
+# Register Tool
The register tool is used to construct register documentation, register RTL and header files.
It is either used stand-alone or by being invoked as part of Markdown processing.
diff --git a/util/reggen/doc/setup_and_use.md b/util/reggen/doc/setup_and_use.md
index 028eecf..8281b38 100644
--- a/util/reggen/doc/setup_and_use.md
+++ b/util/reggen/doc/setup_and_use.md
@@ -1,6 +1,4 @@
----
-title: "Register generator `reggen` and `regtool`"
----
+# Register generator `reggen` and `regtool`
The utility script `regtool.py` and collateral under `reggen` are Python
tools to read register descriptions in Hjson and generate various output
diff --git a/util/rewrite_frontmatter.py b/util/rewrite_frontmatter.py
new file mode 100644
index 0000000..e19a90c
--- /dev/null
+++ b/util/rewrite_frontmatter.py
@@ -0,0 +1,61 @@
+#!/usr/bin/env python3
+# Copyright lowRISC contributors.
+# Licensed under the Apache License, Version 2.0, see LICENSE for details.
+# SPDX-License-Identifier: Apache-2.0
+"""Replaces front-matter with a standard markdown title, ignoring all other fields"""
+
+from pathlib import Path
+import argparse
+
+
+parser = argparse.ArgumentParser()
+parser.add_argument("root_doc",
+ help = "path to the root of documentation")
+g_args = parser.parse_args()
+
+g_root_doc = Path(g_args.root_doc).resolve()
+# if root doc is a link to a book.toml file, just open this one
+assert g_root_doc.is_dir(), "you must give a path to the root of the repo"
+
+
+def apply_to_md_files(path, fn):
+ """
+ List all files under the directory of the book and call a function on each one
+ """
+ def apply_rec(path):
+ for child in path.iterdir():
+ if child.name.endswith(".md"):
+ fn(child)
+ if child.is_dir():
+ apply_rec(child.resolve())
+ apply_rec(path)
+
+
+def rewrite_title(path):
+ relpath = path.relative_to(g_root_doc)
+ # don't touch files in site/, sw/vendor/, hw/vendor/
+ if relpath.parts[0] == "site" or relpath.parts[0:2] in (('sw', 'vendor'), ('hw', 'vendor')):
+ return
+ with path.open() as f:
+ lines = []
+ for line in f:
+ lines.append(line)
+ # it must start with ---
+ if len(lines) == 0 or not lines[0].startswith("---"):
+ return # ignore
+ line_nr = 1
+ title = None
+ while not lines[line_nr].startswith("---"):
+ this_line = lines[line_nr]
+ line_nr += 1
+ if this_line.startswith("title:"):
+ title = this_line[6:].strip()
+ # remove quotes if any
+ if title[0] == '"' and title[-1] == '"':
+ title = title[1:-1]
+ new_lines = [f"# {title}\n"]
+ lines = new_lines + lines[line_nr + 1:]
+ path.write_text("".join(lines))
+
+
+apply_to_md_files(g_root_doc, rewrite_title)
diff --git a/util/tlgen/README.md b/util/tlgen/README.md
index f795a59..c050275 100644
--- a/util/tlgen/README.md
+++ b/util/tlgen/README.md
@@ -1,6 +1,4 @@
----
-title: "Crossbar Generation Tool"
----
+# Crossbar Generation Tool
The crossbar tool `tlgen.py` is used to build the TL-UL crossbar RTL.
It can be used standalone or invoked as part of top module generation process (details of top generation forthcoming).
diff --git a/util/topgen/README.md b/util/topgen/README.md
index 395d43e..b019656 100644
--- a/util/topgen/README.md
+++ b/util/topgen/README.md
@@ -1,6 +1,4 @@
----
-title: "Top Generation Tool"
----
+# Top Generation Tool
The top generation tool `topgen.py` is used to build top specific modules for a specific OpenTitan design - for example [`top_earlgrey`](https://github.com/lowRISC/opentitan/tree/master/hw/top_earlgrey).
Currently, as part of this generation process, the following top specific modules are created
diff --git a/util/uvmdvgen/README.md b/util/uvmdvgen/README.md
index 62c51f7..9072c83 100644
--- a/util/uvmdvgen/README.md
+++ b/util/uvmdvgen/README.md
@@ -1,6 +1,4 @@
----
-title: "Uvmdvgen: Initial testbench auto-generation tool"
----
+# Uvmdvgen: Initial testbench auto-generation tool
`uvmdvgen` is a Python based tool to generate the boilerplate code for a UVM
agent as well as the complete UVM testbench for a given DUT. The tool generates
