Cherry pick PR #1943: Update generated docs with new markdown headers (…

…#1991) Refer to the original PR: #1943 Generation scripts are updated in an internal change. b/236404667 --------- Co-authored-by: Oscar Vestlie <[email protected]>
youtube · Nov 29, 2023 · 0a42d9b · 0a42d9b
1 parent 979c092
commit 0a42d9b
Show file tree

Hide file tree

Showing 166 changed files with 5,182 additions and 5,184 deletions.
diff --git a/cobalt/doc/memory_tuning.md b/cobalt/doc/memory_tuning.md
@@ -1,4 +1,4 @@
-# Memory Tuning #
+# Memory Tuning
 
 Cobalt is designed to choose sensible parameters for memory-related options and
 parameters through a system called "AutoMem".
@@ -16,7 +16,7 @@ Read on for more information.
 *Setting `--max_cobalt_cpu_usage` and `--max_cobalt_gpu_usage` on the
 command line is a beta feature.*
 
-### Memory Settings Table ###
+### Memory Settings Table
 
 A table similar to the one below, will be printed on startup.
 
@@ -79,7 +79,7 @@ be set from a specific place or automatically generated from Cobalt.
       * This value was AutoSet to a default value, but then was reduced in
       response to `max_cobalt_cpu_usage` or `max_cobalt_gpu_usage being` set too low.
 
-### Maximum Memory Table ###
+### Maximum Memory Table
 
 This second table is also printed at startup and details the sum of memory and
 maximum memory limits as reported by cobalt.
@@ -128,13 +128,13 @@ consumed by the settings, then any settings that are AutoSet AND adjustable
 will reduce their memory consumption. When this happens, look for the string
 *`AutoSet (Constrained)`* in the first table.
 
-## Setting Maximum Memory Values ##
+## Setting Maximum Memory Values
 
 The max cpu and gpu memory of the system can be set by command line:
   * `--max_cobalt_cpu_usage=160MB`
   * `--max_cobalt_gpu_usage=160MB`
 
-### Memory Scaling ###
+### Memory Scaling
 
 There are two primary ways in which the memory consumption settings will scale down.
 One is by specifying `--max_cobalt_cpu_usage` (or `max_cobalt_gpu_usage`) to a
@@ -152,15 +152,15 @@ flexible via the command line by setting the value to "autoset". For example,
  `--image_cache_size_in_bytes=auto` will allow `image_cache_size_in_bytes` to be
 flexible by disabling the value being set by a build setting.
 
-### Memory Warnings ###
+### Memory Warnings
 
 Cobalt will periodically check to see if the memory consumed by the application
 is less than the `--max_cobalt_cpu_usage` and `--max_cobalt_gpu_usage` amount.
 If the cpu/gpu exceeds this maximum value then an error message will be logged
 once to stdout for cpu and/or gpu memory systems.
 
 
-### Example 1 - Configuring for a memory restricted platform ###
+### Example 1 - Configuring for a memory restricted platform
 
 Let's say that we are configuring platform called "XXX":
 
@@ -186,7 +186,7 @@ We will configure XXX such that:
 
   * `cobalt --max_cobalt_cpu_usage=160MB`
 
-### Example 2 - Configuring for a memory-plentiful platform ###
+### Example 2 - Configuring for a memory-plentiful platform
 
 The following command line will give a lot of memory to image cache and give
 500MB to `max_cobalt_cpu_usage` and `max_cobalt_gpu_usage`.
@@ -196,9 +196,9 @@ cobalt --max_cobalt_cpu_usage=500MB --max_cobalt_gpu_usage=500MB
 --image_cache_size_in_bytes=80MB
 ~~~
 
-## API Reference ##
+## API Reference
 
-#### Memory System API ####
+#### Memory System API
 
   * `max_cobalt_cpu_usage`
     * This setting will set the maximum cpu memory that the app will consume.
@@ -218,7 +218,7 @@ cobalt --max_cobalt_cpu_usage=500MB --max_cobalt_gpu_usage=500MB
       for `max_cobalt_gpu_usage` in commandline/starboard settings then no
       GPU memory checking is performed.
 
-#### Memory Setting API ####
+#### Memory Setting API
 
   * `image_cache_size_in_bytes`
     * See documentation *Image cache capacity* in `performance_tuning.md` for what
@@ -252,7 +252,7 @@ cobalt --max_cobalt_cpu_usage=500MB --max_cobalt_gpu_usage=500MB
       for what this setting does.
     * Set via command line, or else Cobalt extension, or else automatically by Cobalt.
 
-#### Units for Command Line Settings ####
+#### Units for Command Line Settings
 
 Memory values passed into Cobalt via command line arguments support units such
 kb, mb, and gb for kilo-byte, megabyte, gigabytes. These units are case insensitive.

diff --git a/cobalt/site/docs/gen/cobalt/doc/memory_tuning.md b/cobalt/site/docs/gen/cobalt/doc/memory_tuning.md
@@ -19,7 +19,7 @@ Read on for more information.
 *Setting `--max_cobalt_cpu_usage` and `--max_cobalt_gpu_usage` on the
 command line is a beta feature.*
 
-### Memory Settings Table ###
+### Memory Settings Table
 
 A table similar to the one below, will be printed on startup.
 
@@ -82,7 +82,7 @@ be set from a specific place or automatically generated from Cobalt.
       * This value was AutoSet to a default value, but then was reduced in
       response to `max_cobalt_cpu_usage` or `max_cobalt_gpu_usage being` set too low.
 
-### Maximum Memory Table ###
+### Maximum Memory Table
 
 This second table is also printed at startup and details the sum of memory and
 maximum memory limits as reported by cobalt.
@@ -131,13 +131,13 @@ consumed by the settings, then any settings that are AutoSet AND adjustable
 will reduce their memory consumption. When this happens, look for the string
 *`AutoSet (Constrained)`* in the first table.
 
-## Setting Maximum Memory Values ##
+## Setting Maximum Memory Values
 
 The max cpu and gpu memory of the system can be set by command line:
   * `--max_cobalt_cpu_usage=160MB`
   * `--max_cobalt_gpu_usage=160MB`
 
-### Memory Scaling ###
+### Memory Scaling
 
 There are two primary ways in which the memory consumption settings will scale down.
 One is by specifying `--max_cobalt_cpu_usage` (or `max_cobalt_gpu_usage`) to a
@@ -155,15 +155,15 @@ flexible via the command line by setting the value to "autoset". For example,
  `--image_cache_size_in_bytes=auto` will allow `image_cache_size_in_bytes` to be
 flexible by disabling the value being set by a build setting.
 
-### Memory Warnings ###
+### Memory Warnings
 
 Cobalt will periodically check to see if the memory consumed by the application
 is less than the `--max_cobalt_cpu_usage` and `--max_cobalt_gpu_usage` amount.
 If the cpu/gpu exceeds this maximum value then an error message will be logged
 once to stdout for cpu and/or gpu memory systems.
 
 
-### Example 1 - Configuring for a memory restricted platform ###
+### Example 1 - Configuring for a memory restricted platform
 
 Let's say that we are configuring platform called "XXX":
 
@@ -189,7 +189,7 @@ We will configure XXX such that:
 
   * `cobalt --max_cobalt_cpu_usage=160MB`
 
-### Example 2 - Configuring for a memory-plentiful platform ###
+### Example 2 - Configuring for a memory-plentiful platform
 
 The following command line will give a lot of memory to image cache and give
 500MB to `max_cobalt_cpu_usage` and `max_cobalt_gpu_usage`.
@@ -199,9 +199,9 @@ cobalt --max_cobalt_cpu_usage=500MB --max_cobalt_gpu_usage=500MB
 --image_cache_size_in_bytes=80MB
 ~~~
 
-## API Reference ##
+## API Reference
 
-#### Memory System API ####
+#### Memory System API
 
   * `max_cobalt_cpu_usage`
     * This setting will set the maximum cpu memory that the app will consume.
@@ -221,7 +221,7 @@ cobalt --max_cobalt_cpu_usage=500MB --max_cobalt_gpu_usage=500MB
       for `max_cobalt_gpu_usage` in commandline/starboard settings then no
       GPU memory checking is performed.
 
-#### Memory Setting API ####
+#### Memory Setting API
 
   * `image_cache_size_in_bytes`
     * See documentation *Image cache capacity* in `performance_tuning.md` for what
@@ -255,7 +255,7 @@ cobalt --max_cobalt_cpu_usage=500MB --max_cobalt_gpu_usage=500MB
       for what this setting does.
     * Set via command line, or else Cobalt extension, or else automatically by Cobalt.
 
-#### Units for Command Line Settings ####
+#### Units for Command Line Settings
 
 Memory values passed into Cobalt via command line arguments support units such
 kb, mb, and gb for kilo-byte, megabyte, gigabytes. These units are case insensitive.

diff --git a/cobalt/site/docs/gen/starboard/tools/doc/abstract_launcher.md b/cobalt/site/docs/gen/starboard/tools/doc/abstract_launcher.md
@@ -1,7 +1,6 @@
----
-layout: doc
-title: "App Launchers"
----
+Project: /youtube/cobalt/_project.yaml
+Book: /youtube/cobalt/_book.yaml
+
 # App Launchers
 
 The app launcher framework is used to run an executable on a given platform,

diff --git a/cobalt/site/docs/gen/starboard/tools/doc/testing.md b/cobalt/site/docs/gen/starboard/tools/doc/testing.md
@@ -1,7 +1,6 @@
----
-layout: doc
-title: "Test Runner Documentation"
----
+Project: /youtube/cobalt/_project.yaml
+Book: /youtube/cobalt/_book.yaml
+
 # Test Runner Documentation
 
 The scripts in this folder comprise a cross-platform unit test runner. The

diff --git a/cobalt/site/docs/reference/starboard/configuration-public.md b/cobalt/site/docs/reference/starboard/configuration-public.md
@@ -1,7 +1,7 @@
----
-layout: doc
-title: "Starboard Configuration Reference Guide"
----
+Project: /youtube/cobalt/_project.yaml
+Book: /youtube/cobalt/_book.yaml
+
+Starboard Configuration Reference Guide
 
 ## Architecture Configuration
 

diff --git a/cobalt/site/docs/reference/starboard/gn-configuration.md b/cobalt/site/docs/reference/starboard/gn-configuration.md
@@ -1,7 +1,7 @@
----
-layout: doc
-title: "Starboard: configuration.gni Reference Guide"
----
+Project: /youtube/cobalt/_project.yaml
+Book: /youtube/cobalt/_book.yaml
+
+# Starboard: configuration.gni Reference Guide
 
 | Variables |
 | :--- |