Merge pull request #508 from tordans/patch-1

Docs: Improve examples section
jvalue · Jan 18, 2024 · 7aae6d6 · 7aae6d6
2 parents 4df91f5 + 563e29b
commit 7aae6d6
Show file tree

Hide file tree

Showing 5 changed files with 17 additions and 9 deletions.
diff --git a/apps/docs/docs/user/examples/.gitignore b/apps/docs/docs/user/examples/.gitignore
@@ -2,4 +2,5 @@
 #
 # SPDX-License-Identifier: AGPL-3.0-only
 
+!README.mdx
 *.md
diff --git a/apps/docs/docs/user/examples/README.mdx b/apps/docs/docs/user/examples/README.mdx
@@ -0,0 +1,15 @@
+---
+sidebar_position: 10
+---
+
+# Jayvee Examples
+
+Examples of Jayvee models.
+Copy them to your local file system and execute them with the `jv` command on your command line (see [usage](/docs/user/intro#usage)).
+You can [find all examples on Github](https://github.com/jvalue/jayvee/tree/main/example).
+
+```mdx-code-block
+import DocCardList from '@theme/DocCardList';
+
+<DocCardList />
+```
diff --git a/...ocs/user/examples/_category_.json.license → ...ocs/docs/user/examples/README.mdx.license b/...ocs/user/examples/_category_.json.license → ...ocs/docs/user/examples/README.mdx.license
diff --git a/apps/docs/docs/user/examples/_category_.json b/apps/docs/docs/user/examples/_category_.json
diff --git a/apps/docs/docs/user/intro.md b/apps/docs/docs/user/intro.md
@@ -83,7 +83,7 @@ jv <file> -d --debug-granularity peek --debug-target MyExtractorBlock,MySinkBloc
 
 ## Examples
 
-You can find multiple examples [here](https://github.com/jvalue/jayvee/tree/main/example). Copy them to your local file system and execute them with the `jv` command on your command line (see [usage](#usage)).
+You can find multiple examples with inline explanations [here](./examples/README.mdx).
 
 ## VSCode Plugin