Add Descriptions to Doc Files (#8)

* Add Descriptions to Doc Files * Update services.mdx --------- Co-authored-by: Johnson Chu <[email protected]>
volarjs · Jun 29, 2024 · 602eee3 · 602eee3
1 parent d2936f0
commit 602eee3
Show file tree

Hide file tree

Showing 7 changed files with 8 additions and 2 deletions.
diff --git a/src/content/docs/core-concepts/embedded-languages.mdx b/src/content/docs/core-concepts/embedded-languages.mdx
@@ -1,5 +1,6 @@
 ---
 title: Embedded languages
+description: VolarJS has top-notch support for embedded languages and can drastically simplify the mappings needed to get editing features working across the different parts of your files.
 ---
 
 A lot of programming languages used these days are composed of other programming languages. The most famous example is HTML, in which you will find JavaScript and CSS in `<script>` and `<style>` blocks respectively. In addition to those, you can even find some inline CSS in the `style` attribute of HTML elements, and some inline JavaScript in the `onclick` (and other events) attribute of HTML elements.

diff --git a/src/content/docs/core-concepts/volar-labs.mdx b/src/content/docs/core-concepts/volar-labs.mdx
@@ -1,5 +1,6 @@
 ---
 title: Volar Labs
+description: A VS Code extension to help you debug your Volar-powered language server and client.
 ---
 
 Having a common framework for building editor tooling has many benefits. It allows us to share code, it allows us to share knowledge, and most importantly, it allows us to share the pain of building editor tooling.

diff --git a/src/content/docs/core-concepts/why-volar.mdx b/src/content/docs/core-concepts/why-volar.mdx
@@ -1,5 +1,6 @@
 ---
 title: Why Volar?
+description: Advantages of using Volar and why you would want to use it.
 ---
 
 Over the years, programmers have started relying more and more on their code editors to provide them with helpful contextual information and hints about their code. Features such as hover information, diagnostics, and auto-completions are now an absolute norm that users rightfully expect from their editors, no matter what programming languages they are working with.

diff --git a/src/content/docs/guides/file-structure.mdx b/src/content/docs/guides/file-structure.mdx
@@ -1,5 +1,6 @@
 ---
-title: "File Structure of typical Volar project"
+title: "File Structure of a typical Volar project"
+description: A guide to understand the file structure of a typical Volar project.
 ---
 
 This guide will show you how a Volar project is organized and what the different files in your project do.

diff --git a/src/content/docs/guides/first-server.mdx b/src/content/docs/guides/first-server.mdx
@@ -1,5 +1,6 @@
 ---
 title: Your First Volar Language Server
+description: A simple guide to creating your first Volar language server.
 ---
 
 > This page is a work in progress. Interested in contributing some documentation to it, or want to improve it? [Edit this page on GitHub](https://github.com/volarjs/docs/blob/main/src/content/docs/guides/first-server.mdx)

diff --git a/src/content/docs/index.mdx b/src/content/docs/index.mdx
@@ -1,6 +1,6 @@
 ---
 title: Volar
-description: The Embedded Language Tooling Framework.
+description: VolarJS is a modern embedded language tooling framework that aims to simplify the development of language support for editors. 
 template: splash
 hero:
   tagline: The Embedded Language Tooling Framework.

diff --git a/src/content/docs/reference/services.mdx b/src/content/docs/reference/services.mdx
@@ -1,5 +1,6 @@
 ---
 title: Services
+description: A list of available services in VolarJS and how to use them.
 ---
 
 Services are the building blocks of Volar language servers. They are responsible for providing all the features you'd expect in a language server, completions, diagnostics, hover information, you name it.