make tutorial field short_title optional (#2024)

ocaml · Feb 5, 2024 · 42d4885 · 42d4885
1 parent 41c6dad
commit 42d4885
Show file tree

Hide file tree

Showing 50 changed files with 3 additions and 51 deletions.
diff --git a/data/tutorials/getting-started/1_00_install_OCaml.md b/data/tutorials/getting-started/1_00_install_OCaml.md
@@ -1,7 +1,6 @@
 ---
 id: installing-ocaml
 title: Installing OCaml
-short_title: Installing OCaml
 description: |
   This page will help you install OCaml and the OCaml Platform Tools. |
   These instructions work on Windows, and Unix systems like Linux, and macOS.

diff --git a/data/tutorials/getting-started/1_01_a_tour_of_ocaml.md b/data/tutorials/getting-started/1_01_a_tour_of_ocaml.md
@@ -1,7 +1,6 @@
 ---
 id: tour-of-ocaml
 title: A Tour of OCaml
-short_title: A Tour of OCaml
 description: >
   Hop on the OCaml sightseeing bus. This absolute beginner tutorial will drive you through the marvels and wonders of OCaml. We'll have a look at the most commonly used language features.
 category: "First Steps"

diff --git a/data/tutorials/getting-started/1_02_your_first_ocaml_program.md b/data/tutorials/getting-started/1_02_your_first_ocaml_program.md
@@ -1,7 +1,6 @@
 ---
 id: your-first-program
 title: Your First OCaml Program
-short_title: Your First OCaml Program
 description: >
   Learn how to write your very first OCaml program.
 category: "First Steps"

diff --git a/data/tutorials/getting-started/2_00_editor_setup.md b/data/tutorials/getting-started/2_00_editor_setup.md
@@ -1,7 +1,6 @@
 ---
 id: set-up-editor
 title: Configuring Your Editor
-short_title: Configuring Your Editor
 description: |
   This page will show you how to set up your editor for OCaml. 
 category: "Tooling"

diff --git a/data/tutorials/getting-started/2_01_toplevel.md b/data/tutorials/getting-started/2_01_toplevel.md
@@ -1,7 +1,6 @@
 ---
 id: toplevel-introduction
 title: Introduction to the OCaml Toplevel
-short_title: Introduction to the OCaml Toplevel
 description: |
   This page will give you a brief introduction to the OCaml toplevel.
 category: "Tooling"

diff --git a/data/tutorials/getting-started/2_02_opam_switch.md b/data/tutorials/getting-started/2_02_opam_switch.md
@@ -1,7 +1,6 @@
 ---
 id: opam-switch-introduction
 title: Introduction to opam Switches
-short_title: Introduction to opam Switches
 description: |
   This page will give you a brief introduction to opam switches, what they're used for, and how to create them.
 category: "Tooling"

diff --git a/data/tutorials/getting-started/3_01_ocaml_on_windows.md b/data/tutorials/getting-started/3_01_ocaml_on_windows.md
@@ -1,7 +1,6 @@
 ---
 id: ocaml-on-windows
 title: OCaml on Windows
-short_title: OCaml on Windows
 description: >
   Read about the state of OCaml on Windows and our roadmap to improve Windows support.
 category: "Resources"

diff --git a/data/tutorials/getting-started/3_02_arm_fix.md b/data/tutorials/getting-started/3_02_arm_fix.md
@@ -1,7 +1,6 @@
 ---
 id: arm64-fix
 title: Fix Homebrew Errors on Apple M1
-short_title: Fix Homebrew Errors on Apple M1
 description: |
   This page will walk you through the workaround for ARM64 processors on newer Macs.
 category: "Resources"

diff --git a/data/tutorials/guides/0tt_00_formatting_text.md b/data/tutorials/guides/0tt_00_formatting_text.md
@@ -1,7 +1,6 @@
 ---
 id: formatting-text
 title: Formatting and Wrapping Text
-short_title: Formatting and Wrapping Text
 description: >
   The Format module of Caml Light and OCaml's standard libraries
   provides pretty-printing facilities to get a fancy display for printing

diff --git a/data/tutorials/guides/0tt_01_command_line_arguments.md b/data/tutorials/guides/0tt_01_command_line_arguments.md
@@ -1,7 +1,6 @@
 ---
 id: cli-arguments
 title: Command-line Arguments
-short_title: Command-line Arguments
 description: >
   The Arg module that comes with the compiler can help you write command line interfaces
 category: "Tutorials"

diff --git a/data/tutorials/guides/0tt_02_file_manipulation.md b/data/tutorials/guides/0tt_02_file_manipulation.md
@@ -1,7 +1,6 @@
 ---
 id: file-manipulation
 title: File Manipulation
-short_title: File Manipulation
 description: >
   A guide to basic file manipulation in OCaml with the standard library
 category: "Tutorials"

diff --git a/data/tutorials/guides/0tt_03_calling_c_libraries.md b/data/tutorials/guides/0tt_03_calling_c_libraries.md
@@ -1,7 +1,6 @@
 ---
 id: calling-c-libraries
 title: Calling C Libraries
-short_title: Calling C Libraries
 description: >
   Cross the divide and call C code from your OCaml program
 category: "Tutorials"

diff --git a/data/tutorials/guides/0tt_04_calling_fortran_libraries.md b/data/tutorials/guides/0tt_04_calling_fortran_libraries.md
@@ -1,7 +1,6 @@
 ---
 id: calling-fortran-libraries
 title: Calling Fortran Libraries
-short_title: Calling Fortran Libraries
 description: >
   Cross the divide and call Fortran code from your OCaml program
 category: "Tutorials"

diff --git a/data/tutorials/guides/1wf_00_compiling_ocaml_projects.md b/data/tutorials/guides/1wf_00_compiling_ocaml_projects.md
@@ -1,7 +1,6 @@
 ---
 id: compiling-ocaml-projects
 title: Compiling OCaml Projects
-short_title: Compiling OCaml Projects
 description: >
   An introduction to the OCaml compiler tools for building OCaml projects as well as the most common build tools
 category: "Guides"

diff --git a/data/tutorials/guides/1wf_01_debugging.md b/data/tutorials/guides/1wf_01_debugging.md
@@ -1,7 +1,6 @@
 ---
 id: debugging
 title: Debugging
-short_title: Debugging
 description: >
   Learn to debug OCaml programs using tracing and ocamldebug
 category: "Guides"

diff --git a/data/tutorials/guides/1wf_02_error_handling.md b/data/tutorials/guides/1wf_02_error_handling.md
@@ -1,7 +1,6 @@
 ---
 id: error-handling
 title: Error Handling
-short_title: Error Handling
 description: >
   Discover the different ways you can manage errors in your OCaml programs
 category: "Guides"

diff --git a/data/tutorials/guides/1wf_03_profiling.md b/data/tutorials/guides/1wf_03_profiling.md
@@ -1,7 +1,6 @@
 ---
 id: profiling
 title: Profiling
-short_title: Profiling
 description: >
   Understand how to profile your OCaml code to analyse its performance and produce faster programs
 category: "Guides"

diff --git a/data/tutorials/guides/1wf_05_garbage_collection.md b/data/tutorials/guides/1wf_05_garbage_collection.md
@@ -1,7 +1,6 @@
 ---
 id: garbage-collection
 title: How to Work with the Garbage Collector
-short_title: How to Work with the Garbage Collector
 description: >
   How to use the Gc module in OCaml and how to write your own finalisers.
 category: "Guides"

diff --git a/data/tutorials/guides/rs_00_guidelines.md b/data/tutorials/guides/rs_00_guidelines.md
@@ -1,7 +1,6 @@
 ---
 id: guidelines
 title: OCaml Programming Guidelines
-short_title: OCaml Programming Guidelines
 description: >
   Opinionated guidelines for writing OCaml code
 category: "Resources"

diff --git a/data/tutorials/guides/rs_01_common_error_messages.md b/data/tutorials/guides/rs_01_common_error_messages.md
@@ -1,7 +1,6 @@
 ---
 id: common-errors
 title: Common Error Messages
-short_title: Common Error Messages
 description: >
   Understand the most common error messages the OCaml compiler can throw at you
 category: "Resources"

diff --git a/data/tutorials/guides/rs_02_comparison_of_standard_containers.md b/data/tutorials/guides/rs_02_comparison_of_standard_containers.md
@@ -1,7 +1,6 @@
 ---
 id: data-structures-comparison 
 title: Comparison of Standard Containers
-short_title: Comparison of Standard Containers
 description: >
   Rough comparison of the different container types in OCaml
 category: "Resources"

diff --git a/data/tutorials/language/0it_00_values_functions.md b/data/tutorials/language/0it_00_values_functions.md
@@ -1,7 +1,6 @@
 ---
 id: values-and-functions
 title: Values and Functions
-short_title: Values and Functions
 description: |
   Functions, values, definitions, environments, scopes, closures, and shadowing. This tutorial will help you master the fundamentals.
 category: "Introduction"

diff --git a/data/tutorials/language/0it_01_basic_datatypes.md b/data/tutorials/language/0it_01_basic_datatypes.md
@@ -1,7 +1,6 @@
 ---
 id: basic-data-types
 title: Basic Data Types and Pattern Matching
-short_title: Basic Data Types and Pattern Matching
 description: |
   Predefined Types, Variants, Records, and Pattern Matching
 category: "Introduction"

diff --git a/data/tutorials/language/0it_02_loops_and_recursion.md b/data/tutorials/language/0it_02_loops_and_recursion.md
@@ -1,7 +1,6 @@
 ---
 id: loops-recursion
 title: Loops and Recursions
-short_title: Loops and Recursions
 description: >
   Learn basic control-flow and recursion in OCaml
 category: "Introduction"

diff --git a/data/tutorials/language/0it_03_lists.md b/data/tutorials/language/0it_03_lists.md
@@ -1,7 +1,6 @@
 ---
 id: lists
 title: Lists
-short_title: Lists
 description: >
   Learn about one of OCaml's must used, built-in data types
 category: "Introduction"

diff --git a/data/tutorials/language/0it_04_labels.md b/data/tutorials/language/0it_04_labels.md
@@ -1,7 +1,6 @@
 ---
 id : labels
 title: Labelled and Optional Arguments
-short_title: Labelled and Optional Arguments
 description: >
   Provide labels to your functions arguments
 category: "Introduction"

diff --git a/data/tutorials/language/0it_05_imperative.md b/data/tutorials/language/0it_05_imperative.md
@@ -1,7 +1,6 @@
 ---
 id: mutability-imperative-control-flow
 title: Mutability and Imperative Control Flow
-short_title: Mutability and Imperative Control Flow
 description: >
   Write stateful programs in OCaml. Use for and while loops, if-then-else, mutable record fields, and references.
 category: "Introduction"

diff --git a/data/tutorials/language/1ms_00_modules.md b/data/tutorials/language/1ms_00_modules.md
@@ -1,7 +1,6 @@
 ---
 id: modules
 title: Modules
-short_title: Modules
 description: >
   Modules are collections of definitions. This is the basic means to organise OCaml software.
 category: "Module System"

diff --git a/data/tutorials/language/1ms_01_functors.md b/data/tutorials/language/1ms_01_functors.md
@@ -1,7 +1,6 @@
 ---
 id: functors
 title: Functors
-short_title: Functors
 description: >
   In OCaml, a functor is a function at the module-level. Functors take modules as arguments and return a new module.
 category: "Module System"

diff --git a/data/tutorials/language/1ms_02_dune.md b/data/tutorials/language/1ms_02_dune.md
@@ -1,7 +1,6 @@
 ---
 id: libraries-dune
 title: Libraries With Dune
-short_title: Libraries With Dune
 description: >
   Dune provides several means to arrange modules into libraries. We look at Dune's mechanisms for structuring projects with libraries that contain modules.
 category: "Module System"

diff --git a/data/tutorials/language/3ds_00_options.md b/data/tutorials/language/3ds_00_options.md
@@ -1,7 +1,6 @@
 ---
 id: options
 title: Options
-short_title: Options
 description: >
   Add nothing-as-value to anything to avoid confusion between something and “no such thing“.
 category: "Data Structures"

diff --git a/data/tutorials/language/3ds_01_arrays.md b/data/tutorials/language/3ds_01_arrays.md
@@ -1,7 +1,6 @@
 ---
 id: arrays
 title: Arrays
-short_title: Arrays
 description: >
   The standard library's Array module
 category: "Data Structures"

diff --git a/data/tutorials/language/3ds_02_map.md b/data/tutorials/language/3ds_02_map.md
@@ -1,7 +1,6 @@
 ---
 id: map
 title: Map
-short_title: Map
 description: >
   Create a mapping using the standard library's Map module
 category: "Data Structures"

diff --git a/data/tutorials/language/3ds_03_set.md b/data/tutorials/language/3ds_03_set.md
@@ -1,7 +1,6 @@
 ---
 id: sets
 title: Set
-short_title: Set
 description: >
   The standard library's Set module
 category: "Data Structures"

diff --git a/data/tutorials/language/3ds_04_hashtbl.md b/data/tutorials/language/3ds_04_hashtbl.md
@@ -1,7 +1,6 @@
 ---
 id: hash-tables
 title: Hash Tables
-short_title: Hash Tables
 description: >
   Discover efficient and mutable lookup tables with OCaml's Hashtbl module
 category: "Data Structures"

diff --git a/data/tutorials/language/3ds_05_seq.md b/data/tutorials/language/3ds_05_seq.md
@@ -1,7 +1,6 @@
 ---
 id: sequences
 title: Sequences
-short_title: Sequences
 description: >
   Learn about sequences, of OCaml's most-used, built-in data types
 category: "Data Structures"

diff --git a/data/tutorials/language/3ds_06_memoization.md b/data/tutorials/language/3ds_06_memoization.md
@@ -1,7 +1,6 @@
 ---
 id: memoization
 title: Memoization
-short_title: Memoization
 description: >
   Memoization, adapted from OCaml Programming: Correct + Efficient + Beautiful
 category: "Data Structures"

diff --git a/data/tutorials/language/3ds_07_monads.md b/data/tutorials/language/3ds_07_monads.md
@@ -1,7 +1,6 @@
 ---
 id: monads
 title: Monads
-short_title: Monads
 description: >
   Monads, adapted from OCaml Programming: Correct + Efficient + Beautiful
 category: "Data Structures"

diff --git a/data/tutorials/language/4ad_00_metaprogramming.md b/data/tutorials/language/4ad_00_metaprogramming.md
@@ -1,7 +1,6 @@
 ---
 id: metaprogramming
 title: Preprocessors and PPXs
-short_title: Preprocessors and PPXs
 description: |
   An introduction to metaprogramming in OCaml, including preprocessors, PPX
   extensions and the `ppxlib` library.

diff --git a/data/tutorials/language/4ad_01_operators.md b/data/tutorials/language/4ad_01_operators.md
@@ -1,7 +1,6 @@
 ---
 id: operators
 title: Operators
-short_title: Operators
 description: |
   Binary and prefix operators, how to use and define them, how they are parsed and evaluated.
 category: "Advanced Topics"

diff --git a/data/tutorials/language/4ad_02_objects.md b/data/tutorials/language/4ad_02_objects.md
@@ -1,7 +1,6 @@
 ---
 id: objects
 title: Objects
-short_title: Objects
 description: >
   OCaml is an object-oriented, imperative, functional programming language
 category: "Advanced Topics"

diff --git a/data/tutorials/language/5rt_00_memory_representation.md b/data/tutorials/language/5rt_00_memory_representation.md
@@ -1,7 +1,6 @@
 ---
 id: memory-representation
 title: Memory Representation of Values
-short_title: Memory Representation of Values
 description: >
   Memory Representation of Values, excerpt from Real World OCaml
 category: "Runtime & Compiler"

diff --git a/data/tutorials/language/5rt_01_garbage-collector.md b/data/tutorials/language/5rt_01_garbage-collector.md
@@ -1,7 +1,6 @@
 ---
 id: garbage-collector
 title: Understanding the Garbage Collector
-short_title: Understanding the Garbage Collector
 description: >
   Understanding the Garbage Collector, excerpt from Real World OCaml
 category: "Runtime & Compiler"

diff --git a/data/tutorials/platform/bp_01_managing_deps.md b/data/tutorials/platform/bp_01_managing_deps.md
@@ -1,7 +1,6 @@
 ---
 id: "managing-dependencies"
 title: "Managing Dependencies With opam"
-short_title: "Managing Dependencies With opam"
 description: |
   How to manage dependencies with opam
 category: "Best Practices"

diff --git a/data/tutorials/platform/bp_06_configuring_your_editor.md b/data/tutorials/platform/bp_06_configuring_your_editor.md
@@ -1,7 +1,6 @@
 ---
 id: "configuring-your-editor"
 title: "Configuring Your Editor"
-short_title: "Configuring Your Editor"
 description: |
   How to set up Editor support for OCaml on VSCode, Vim and Emacs
 category: "Best Practices"

diff --git a/data/tutorials/platform/bp_09_opam_path.md b/data/tutorials/platform/bp_09_opam_path.md
@@ -1,7 +1,6 @@
 ---
 id: "opam-path"
 title: "Running Commands in an opam Switch"
-short_title: "Running Commands in an opam Switch"
 description: |
   How to use commands installed in an opam switch
 category: "Best Practices"

diff --git a/data/tutorials/platform/op_00_principles.md b/data/tutorials/platform/op_00_principles.md
@@ -1,7 +1,6 @@
 ---
 id: "platform-principles"
 title: "Guiding Principles"
-short_title: "Guiding Principles"
 description: The principles that guide the development of the OCaml Platform.
 category: "OCaml Platform"
 ---

diff --git a/data/tutorials/platform/op_01_users.md b/data/tutorials/platform/op_01_users.md
@@ -1,7 +1,6 @@
 ---
 id: "platform-users"
 title: "Users"
-short_title: "Users"
 description: The principles that guide the development of the OCaml Platform.
 category: "OCaml Platform"
 ---

diff --git a/data/tutorials/platform/op_02_roadmap.md b/data/tutorials/platform/op_02_roadmap.md
@@ -1,7 +1,6 @@
 ---
 id: "platform-roadmap"
 title: "OCaml Platform Roadmap"
-short_title: "OCaml Platform Roadmap"
 description: The 2024-2026 roadmap for the OCaml Platform.
 category: "OCaml Platform"
 ---