[docs] AMPER-4972 Add specific descriptions to all pages

joffrey-bion · joffrey-bion · commit 25e6d832d5e9 · 2026-01-27T11:47:17.000+01:00
(cherry picked from commit 1ad8f4b)
diff --git a/docs/src/cli/index.md b/docs/src/cli/index.md
@@ -1,3 +1,6 @@
+---
+description: The Amper CLI is a command-line tool to build, run, test, and package your project without an IDE.
+---
 # :octicons-terminal-16: Amper CLI
 
 The Amper CLI is a command-line tool to build, run, test, and package your project without an IDE.
diff --git a/docs/src/cli/provisioning.md b/docs/src/cli/provisioning.md
@@ -1,3 +1,8 @@
+---
+description: |
+  Part of Amper's philosophy is to avoid the hassle of setting up toolchains, including the JDK and Amper 
+  itself. This is why we recommend checking the Amper wrapper script into your project's root folder.
+---
 # Wrapper script & provisioning
 
 Part of Amper's philosophy is to avoid the hassle of setting up toolchains, including the JDK and Amper itself.
diff --git a/docs/src/faq.md b/docs/src/faq.md
@@ -1,4 +1,5 @@
 ---
+description: Frequently asked questions about Amper.
 hide:
   - navigation
 ---
diff --git a/docs/src/getting-started/ide-setup.md b/docs/src/getting-started/ide-setup.md
@@ -1,3 +1,6 @@
+---
+description: This page describes how to set up your IDE to work with Amper.
+---
 # IDE Setup
 
 ??? question "Do I need to use IntelliJ IDEA?"
diff --git a/docs/src/getting-started/index.md b/docs/src/getting-started/index.md
@@ -1,3 +1,6 @@
+---
+description: "Ready to try Amper? Choose the right approach for you: examples, tutorial, user guide..."
+---
 # Getting started
 
 Ready to try Amper? Choose the right approach for you:
diff --git a/docs/src/getting-started/tutorial.md b/docs/src/getting-started/tutorial.md
@@ -1,3 +1,8 @@
+---
+description: |
+  Learn by doing with this step-by-step Amper tutorial. Create a Hello World project from scratch, and 
+  make it more and more interesting until you turn it into a complete Compose multiplatform application.
+---
 # Tutorial
 
 This tutorial gives a short introduction to Amper and shows how to create and configure a new project, step-by-step.
diff --git a/docs/src/reference/module.md b/docs/src/reference/module.md
@@ -1,3 +1,6 @@
+---
+description: An exhaustive reference of the module file format.
+---
 # Module file reference
 
 ## `aliases`
diff --git a/docs/src/reference/project.md b/docs/src/reference/project.md
@@ -1,3 +1,6 @@
+---
+description: An exhaustive reference of the project file format.
+---
 # Project file reference
 
 ## `modules`
diff --git a/docs/src/user-guide/advanced/java-annotation-processing.md b/docs/src/user-guide/advanced/java-annotation-processing.md
@@ -1,3 +1,6 @@
+---
+description: This page describes how to add java annotation processors to your module.
+---
 # Java annotation processing
 
 To add java annotation processors to your module, add their maven coordinates to the
diff --git a/docs/src/user-guide/advanced/kotlin-compiler-plugins.md b/docs/src/user-guide/advanced/kotlin-compiler-plugins.md
@@ -1,3 +1,6 @@
+---
+description: This page describes how to add Kotlin compiler plugins to your module.
+---
 # Kotlin compiler plugins
 
 Compiler plugins are a powerful feature of Kotlin that allow you to extend the language with new features.
diff --git a/docs/src/user-guide/advanced/ksp.md b/docs/src/user-guide/advanced/ksp.md
@@ -1,3 +1,8 @@
+---
+description: |
+  Kotlin Symbol Processing (KSP) is a tool that allows feeding Kotlin source code to processors, which can in turn use
+  this information to generate code, classes, or resources, for instance. Amper provides built-in support for KSP.
+---
 # Kotlin Symbol Processing (KSP)
 
 [Kotlin Symbol Processing](https://kotlinlang.org/docs/ksp-overview.html) is a tool that allows feeding Kotlin source
diff --git a/docs/src/user-guide/advanced/maven-like-layout.md b/docs/src/user-guide/advanced/maven-like-layout.md
@@ -1,3 +1,9 @@
+---
+description: |
+  Amper is opinionated about where to put your sources, resources, and tests.
+  The maven-like module layout allows to keep the same directory structure as Maven and Gradle, which is especially 
+  useful when transitioning from these tools.
+---
 # Maven-like module layout
 
 Amper is opinionated about where to put your sources, resources, and tests (see the 
diff --git a/docs/src/user-guide/basics.md b/docs/src/user-guide/basics.md
@@ -1,3 +1,8 @@
+---
+description: |
+  If you have never used Amper before, this is the best place to start. In this section, we will learn about the basic
+  entities in Amper, the general project layout, and how configuration files look.
+---
 # Basic concepts
 
 If you have never used Amper before, this is the best place to start. In this section, we will learn about the basic
diff --git a/docs/src/user-guide/builtin-tech/compose-multiplatform.md b/docs/src/user-guide/builtin-tech/compose-multiplatform.md
@@ -1,3 +1,8 @@
+---
+description: |
+  Compose Multiplatform is a declarative UI framework developed by JetBrains for sharing Kotlin UI code across multiple
+  platforms. Amper provides support for it out of the box.
+---
 # :jetbrains-compose-multiplatform: Compose Multiplatform
 
 [Compose Multiplatform](https://www.jetbrains.com/compose-multiplatform/) is a declarative UI framework developed by
diff --git a/docs/src/user-guide/builtin-tech/kotlin-serialization.md b/docs/src/user-guide/builtin-tech/kotlin-serialization.md
@@ -1,3 +1,8 @@
+---
+description: |
+  Kotlin Serialization is the official multiplatform and multi-format serialization library for Kotlin.
+  Amper provides support for it out of the box.
+---
 # Kotlin Serialization
 
 [Kotlin Serialization](https://github.com/Kotlin/kotlinx.serialization) is the official multiplatform and multi-format
diff --git a/docs/src/user-guide/builtin-tech/ktor.md b/docs/src/user-guide/builtin-tech/ktor.md
@@ -1,3 +1,8 @@
+---
+description: |
+  Ktor is a Kotlin framework for building asynchronous server-side and client-side applications.
+  Amper provides support for it out of the box.
+---
 # :jetbrains-ktor: Ktor
 
 [Ktor](https://ktor.io/) is a Kotlin framework for building asynchronous server-side and client-side applications.
diff --git a/docs/src/user-guide/builtin-tech/lombok.md b/docs/src/user-guide/builtin-tech/lombok.md
@@ -1,3 +1,8 @@
+---
+description: |
+  Project Lombok is a Java library that generates getters, setters, builders, and other boilerplate code from 
+  annotations. Amper provides support for it out of the box.
+---
 # :intellij-lombok: Lombok
 
 [Project Lombok](https://projectlombok.org/) is a Java library that generates getters, setters, builders, 
diff --git a/docs/src/user-guide/builtin-tech/spring.md b/docs/src/user-guide/builtin-tech/spring.md
@@ -1,3 +1,8 @@
+---
+description: |
+  Spring Boot is a framework that simplifies the creation of stand-alone, Spring-based applications.
+  Amper provides support for it out of the box.
+---
 # :spring-boot: Spring Boot
 
 [Spring Boot](https://spring.io/projects/spring-boot) is a framework that simplifies the creation of stand-alone,
diff --git a/docs/src/user-guide/dependencies.md b/docs/src/user-guide/dependencies.md
@@ -1,3 +1,8 @@
+---
+description: |
+  Learn everything about dependencies in Amper: maven coordinates, scopes, library catalogs, repository configuration,
+  and more.
+---
 # Dependencies
 
 Dependencies are pieces of code (e.g., libraries or other modules) that your module depends on.
diff --git a/docs/src/user-guide/index.md b/docs/src/user-guide/index.md
@@ -1,3 +1,8 @@
+---
+description: |
+  This is the comprehensive documentation of Amper.
+  Here, you can learn everything about Amper concepts and features, and its support for some popular technologies.
+---
 # User guide
 
 This is the comprehensive documentation of Amper.
@@ -8,4 +13,4 @@ Here, you can learn everything about Amper concepts and features, and its suppor
     The sections are organized in a logical order, so if you're not sure how to proceed, you can use the 
     "Next :material-arrow-right:" button at the bottom of the pages to go with the flow.
 
-For a more hands-on experience, check out the [Getting started](../getting-started/index.md) guide.
+For a more hands-on experience, check out the [Getting started](../getting-started/index.md) guide.
diff --git a/docs/src/user-guide/multiplatform.md b/docs/src/user-guide/multiplatform.md
@@ -1,3 +1,8 @@
+---
+description: |
+  Learn everything about Kotlin Multiplatform configuration in Amper module files: supported platforms, platform 
+  qualifiers, module layout, and more.
+---
 # Multiplatform modules
 
 Amper was built from the start with [Kotlin Multiplatform](https://kotlinlang.org/docs/multiplatform/kmp-overview.html)
diff --git a/docs/src/user-guide/plugins/overview.md b/docs/src/user-guide/plugins/overview.md
@@ -1,3 +1,6 @@
+---
+description: A bird-eye view of the Amper plugins features and plans.
+---
 # Plugins in Amper
 
 !!! tip "Important"
diff --git a/docs/src/user-guide/plugins/quick-start.md b/docs/src/user-guide/plugins/quick-start.md
@@ -1,3 +1,6 @@
+---
+description: Get started with writing your own build plugins for Amper.
+---
 # Quick Start
 
 ## How to write a plugin
diff --git a/docs/src/user-guide/plugins/topics/configuration.md b/docs/src/user-guide/plugins/topics/configuration.md
@@ -1,3 +1,6 @@
+---
+description: A guide to Amper's plugin configuration system.
+---
 # Configuration
 
 This section provides details on how to configure tasks and plugin settings, how the schema works, default values and more.
diff --git a/docs/src/user-guide/plugins/topics/references.md b/docs/src/user-guide/plugins/topics/references.md
@@ -1,3 +1,6 @@
+---
+description: Learn how to use Amper references in YAML for effective plugin configuration wiring.
+---
 # References
 
 Amper uses its own value‑reference system using the `${...}` syntax.
diff --git a/docs/src/user-guide/plugins/topics/structure.md b/docs/src/user-guide/plugins/topics/structure.md
@@ -1,3 +1,6 @@
+---
+description: Learn everything about the structure of Amper plugin modules and how to use them in your project.
+---
 # Plugin structure
 
 A plugin is a standard Amper module with the `jvm/amper-plugin` product type. 
diff --git a/docs/src/user-guide/plugins/topics/tasks.md b/docs/src/user-guide/plugins/topics/tasks.md
@@ -1,3 +1,7 @@
+---
+description: |
+  Learn how to implement and register custom tasks in Amper plugins, and how they are executed.
+---
 # Tasks
 
 ## Task action definition
diff --git a/docs/src/user-guide/product-types/android-app.md b/docs/src/user-guide/product-types/android-app.md
@@ -1,3 +1,6 @@
+---
+description: Learn how to use the `android/app` product type in a module to build an Android application.
+---
 # :android-head-flat: Android application
 
 Use the `android/app` product type in a module to build an Android application.
diff --git a/docs/src/user-guide/product-types/index.md b/docs/src/user-guide/product-types/index.md
@@ -1,3 +1,8 @@
+---
+description: |
+  Learn about the different product types supported by Amper:
+  JVM, mobile, or native applications; JVM or KMP libraries, etc.
+---
 # Product types
 
 Each module has a product type defined by the `product` field in `module.yaml`, indicating what is created when building
diff --git a/docs/src/user-guide/product-types/ios-app.md b/docs/src/user-guide/product-types/ios-app.md
@@ -1,3 +1,6 @@
+---
+description: Learn how to use the `ios/app` product type in a module to build an iOS application.
+---
 # :simple-apple: iOS application
 
 Use the `ios/app` product type in a module to build an iOS application.
diff --git a/docs/src/user-guide/product-types/js-app.md b/docs/src/user-guide/product-types/js-app.md
@@ -1,3 +1,8 @@
+---
+description: |
+  Learn how to use the `js/app` product type in a module to build a JavaScript application using the Kotlin/JS 
+  technology.
+---
 # :material-language-javascript: Kotlin/JS application
 
 Use the `js/app` product type in a module to build a JavaScript application using the 
diff --git a/docs/src/user-guide/product-types/jvm-app.md b/docs/src/user-guide/product-types/jvm-app.md
@@ -1,3 +1,6 @@
+---
+description: Learn how to use the `jvm/app` product type in a module to build a JVM console or desktop application.
+---
 # :intellij-java: JVM application
 
 Use the `jvm/app` product type in a module to build a JVM console or desktop application.
diff --git a/docs/src/user-guide/product-types/jvm-lib.md b/docs/src/user-guide/product-types/jvm-lib.md
@@ -1,3 +1,6 @@
+---
+description: Learn how to use the `jvm/lib` product type in a module to build a JVM library.
+---
 # :intellij-java: JVM library
 
 Use the `jvm/lib` product type in a module to build a JVM library.
diff --git a/docs/src/user-guide/product-types/kmp-lib.md b/docs/src/user-guide/product-types/kmp-lib.md
@@ -1,3 +1,6 @@
+---
+description: Learn how to use the `lib` product type in a module to build a Kotlin Multiplatform library.
+---
 # :jetbrains-kotlin-multiplatform: Kotlin Multiplatform library
 
 Use the `lib` product type in a module to build a 
diff --git a/docs/src/user-guide/product-types/native-app.md b/docs/src/user-guide/product-types/native-app.md
@@ -1,3 +1,6 @@
+---
+description: Learn how to build Kotlin/Native applications for the Linux, macOS, and Windows platforms using Amper.
+---
 # :fontawesome-solid-microchip: Kotlin/Native application
 
 Native applications are applications that run on the host operating system.
diff --git a/docs/src/user-guide/product-types/wasm-app.md b/docs/src/user-guide/product-types/wasm-app.md
@@ -1,3 +1,6 @@
+---
+description: Learn how to use the wasmJs/app and wasmWasi/app product types in a module to build WebAssembly applications.
+---
 # :simple-webassembly: Kotlin/Wasm application
 
 Use the `wasmJs/app` or `wasmWasi/app` product type in a module to build a WebAssembly application using the 
diff --git a/docs/src/user-guide/templates.md b/docs/src/user-guide/templates.md
@@ -1,3 +1,6 @@
+---
+description: This page describes how to use templates to share configuration between modules in the project.
+---
 # Templates
 
 In modularized projects, there is often a need to have a certain common configuration for all or some modules.
diff --git a/docs/src/user-guide/testing.md b/docs/src/user-guide/testing.md
@@ -1,3 +1,6 @@
+---
+description: This page describes how tests work in Amper.
+---
 # Testing
 
 Test code is located in the `test/` folder:
diff --git a/docs/src/user-guide/yaml-primer.md b/docs/src/user-guide/yaml-primer.md
@@ -1,3 +1,6 @@
+---
+description: A brief introduction to the YAML language used in Amper configuration files.
+---
 # Brief YAML primer
 
 Amper uses (a subset of) the YAML language for configuration files.

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,5 @@`
`1`	`1`	`---`
	`2`	`+description: Frequently asked questions about Amper.`
`2`	`3`	`hide:`
`3`	`4`	`- navigation`
`4`	`5`	`---`