Merge pull request #73 from codefori/feature/examples-view

Add docs on custom examples support in db2i extension

Author: sebjulliand

.astro/settings.json

@@ -1,5 +1,5 @@
 {
 	"_variables": {
-		"lastUpdateCheck": 1752178270354
+		"lastUpdateCheck": 1756490224047
 	}
 }

src/content/docs/extensions/db2i/images/examplesAdd.png

@@ -135,6 +135,21 @@ The Db2 for i extension adds a view called Schema Browser which allows the user
 
 If you are using the Schema Browser to browse objects, you are able to use the 'View contents' icon when hovering over a table, view, or alias to cause a basic SQL select statement to be generated and executed.
 
+
+## Using Examples
+
+The Examples view provides users with a set of SQL example scripts that can be used as a learning tool or as a starting point for their own SQL scripts. These examples are grouped into categories to make it easy to find what you are looking for. You can hover over any example to get a preview of the SQL script or click on it to open a copy which you can freely edit.
+
+![](./images/examplesPreview.png)
+
+On top of the built-in examples, users can also add specific directories containing their own SQL examples using the `Add...` button under the `Custom Examples Directories` submenu on the Examples view. All SQL files in the specified directories and at most one subdirectory level deeper will be picked up. By default, the folder name will be the category and the file name will be the name of the example. This can be customized by optionally including a comment in the file with the tags `category` and `description`.
+
+![](./images/examplesAdd.png)
+
+Once you have added a custom examples directory, you can quickly save new examples to that directory using the `Save As New Example` button in the Examples view.
+
+![](./images/examplesSave.png)
+
 ## SQL Error Logging Facility (SELF)
 
 SQL Error Logging Facility (SELF) offers a comprehensive view that can help users understand specific SQL errors or warnings. The SELF view can be accessed through the IBM i panel next to the Results View.