First draft of DaxLib documentation

marcosqlbi · marcosqlbi · commit a42a5c5ae7bd · 2025-08-25T16:53:09.000+02:00
diff --git a/_mydocs/contribute/index.md b/_mydocs/contribute/index.md
@@ -4,7 +4,52 @@ title:          Contribute to DAX Lib
 menu_title:     Contribute
 published:      true
 date:           2025-08-14
-modified:       2025-08-14
+modified:       2025-08-25
 order:          /02
 next_reading:   true
 ---
+
+A DAX library is deployed as a package in DAX Lib. A package is a ZIP file that includes a few files (**TODO add package description**).
+
+You can follow these steps to add a new package to DAX Lib:
+
+1. **Clone** the GitHub repository [https://github.com/sql-bi/daxlib/](https://github.com/sql-bi/daxlib/).
+
+2. **Create a folder** for your package in `/packages/`, for example by copying the daxlib.sample package.
+
+    a. Name the folder after your package using lowercase names (e.g., `test.functions`), while the package should have a pascal naming convention (e.g., `Test.Functions`).
+
+    b. The package and library name is the prefix of all the function names. For example, to functions `Sum` and `Multiply` in the `Test.Functions` library package should be named `Test.Functions.Sum` and `Test.Functions.Multiply`.
+
+    c. The package and library name must have a hierarchical nomenclature, where the first name is the published/author identifier and the second (and following) names identify the library scope. For example, `Contoso.Conversion` is a library of conversion functions made by Contoso, whereas `Northwind.Math.Geometry` is a set of geometrical mathematical functions made by Northwind.
+
+    d. Do not use `Dax.` in the name of the library (Dax as a single word is a reserved keyword in a function name).
+
+    e. `DaxLib.` as a prefix is a reserved word for public open-source libraries of common use that are reviewed and approved by DaxLib maintainers. Do not create pull request for new `DaxLib.` libraries. 
+
+    f. The first level in the folder structure is a single letter corresponding to the first letter of the package name (for example, a package `test.functions` will be in `/packages/t/test.functions/` folder). This is a technique used to reduce the number of elements in a single folder.
+
+    g. All the names of folders and files must be lowercase; the name of the package (with uppercase letters if necessary) is defined in the metadata (`manifest.daxlib` file) of the package.
+
+3. **Create the DAX functions** in `functions.tmdl`
+
+    a. The file `lib/functions.tmdl` contains the source code of the DAX functions in a TMDL createOrReplace command. For example, in `test.functions` the name is `/packages/t/test.functions/lib/functions.tmdl`
+
+    b. The `functions.tmdl` file contains the function definition using the TMDL syntax following the `createOrReplace` statement
+
+    c. Include mandatory annotations for each function of the library:
+
+        annotation DAXLIB_PackageId = <name of library>`
+        annotation DAXLIB_PackageVersion = <version of library>
+
+4. **Create the manifest** in the `manifest.daxlib` file
+    
+    a. For example, in `test.functions` the name is `/packages/t/test.functions/manifest.daxlib`
+
+    b. The `manifest.daxlib` file includes the properties of the package in JSON format. See [https://daxlib.org/package/DaxLib.Sample/#code](https://daxlib.org/package/DaxLib.Sample/#code) to get an example
+
+5. **Create a pull request** to publish the library on daxlib.org
+
+    a. The pull request must be approved manually by DaxLib owners/maintainers.
+
+    b. When the pull request is approved, the package is immediately published.
diff --git a/_mydocs/integrate/index.md b/_mydocs/integrate/index.md
@@ -4,8 +4,13 @@ title:          Integrate DAX Lib with Third-Party Tools
 menu_title:     Integrate
 published:      true
 date:           2025-08-14
-modified:       2025-08-14
+modified:       2025-08-25
 order:          /03
 next_reading:   true
 ---
 
+[DaxLib.Client](https://www.nuget.org/packages/DaxLib.Client) is the NuGet package that can be used by external tools to integrate with [DaxLib](https://daxlib.org) directly:
+- Create packages
+- Download packages
+
+**NOTE**: Currently, the client does not add the functions to the semantic model, the external tool does that (like Tabular Editor). However, this feature will be added soon in the client before the integration with [Bravo for Power BI](https://bravo.bi).
diff --git a/_mydocs/user-guide/add-to-power-bi.md b/_mydocs/user-guide/add-to-power-bi.md
@@ -3,6 +3,20 @@ layout:         page
 title:          Add to Power BI
 published:      true
 date:           2025-08-14
-modified:       2025-08-14
+modified:       2025-08-25
 order:          /user-guide/02
 ---
+
+When you click the **Add to Power BI** button, you can copy the DAX library code to your clipboard and then paste it into the TMDL View of your Power BI semantic model.
+
+1. *(optional)* With the **Show Code** button, you can view the code of the library before clicking **Copy** . This way, you can inspect the library code before moving forward.
+
+2. After you click **Copy**, the code will be copied to your clipboard.
+
+3. In Power BI, **open the TMDL View** of your semantic model.
+
+4. In the TMDL view, and **paste** the code into the editor (CTRL+V).
+
+5. Click **Apply** in the TMDL View. 
+
+6. Done! You can start using the functions in any DAX expression of your semantic model.
diff --git a/_mydocs/user-guide/getting-started.md b/_mydocs/user-guide/getting-started.md
@@ -3,6 +3,18 @@ layout:         page
 title:          Getting Started
 published:      true
 date:           2025-08-14
-modified:       2025-08-14
+modified:       2025-08-25
 order:          /user-guide/01
 ---
+
+1. **Find the library** you want using the search and browse features on [DAX Lib](https://daxlib.org).
+
+2. Use the **view code** feature to view the content of a DAX library.
+
+    a. Use **F1** to open the command palette
+
+    b. Use **Collapse All** to collapse all expanded code blocks and see only the function names.
+
+    c. Use **Find** to look for a specific function name or description.
+
+3. Use **Add to Power BI** to copy the DAX library code to add to your semantic model.
diff --git a/_mydocs/user-guide/index.md b/_mydocs/user-guide/index.md
@@ -3,9 +3,9 @@ layout:         page
 title:          User Guide
 published:      true
 date:           2025-08-14
-modified:       2025-08-14
+modified:       2025-08-25
 order:          /01
 next_reading:   true
 ---
 
-This document provides a collection of user guides for the DAX Lib services. These guides are designed to help you understand how to use the various features and functionalities of DAX Lib effectively.
+This document provides a collection of user guides for the DAX Lib services. These guides are designed to help you understand how to use the various features and functionalities of DAX Lib.
diff --git a/_mydocs/what-is.md b/_mydocs/what-is.md
@@ -3,7 +3,47 @@ layout:         page
 title:          What is DAX Lib?
 published:      true
 date:           2025-08-14
-modified:       2025-08-14
+modified:       2025-08-25
 order:          /001
 next_reading:   true
 ---
+
+DAX Lib is a website designed to distribute libraries of DAX user-defined functions (UDF). Similar to NuGet, DAX Lib provides a centralized platform where users can discover, share, and download reusable DAX function libraries to enhance their Fabric, Power BI, and Analysis Services semantic models.
+
+# DAX libraries
+A DAX library is a collection of DAX user-defined functions that can be reused across different semantic models, promoting best practices and reducing duplication of effort.
+
+## Functions designed for DAX libraries
+A DAX user-defined function is candidate for a library if it is model-independent, which means that it has no references to specific tables, columns, or measures within a particular model. When a function has direct dependencies on model elements, it is not suitable for inclusion in a DAX library and must be refactored to remove those dependencies.
+
+Example of a **model-independent function**, good candidate for a DAX library:
+```DAX
+    FUNCTION RangeLookup = (
+            search : SCALAR VAL,
+            lookupTable : TABLEREF EXPR,
+            colMin : COLUMNREF EXPR,
+            colMax : COLUMNREF,
+            colTarget : COLUMNREF
+        ) =>
+        SELECTCOLUMNS (
+            FILTER ( 
+                lookupTable, 
+                colMin <= search && colMax > search 
+            ),
+            "@Result", colTarget
+        )
+```
+
+Example of a **model-dependent function**, which could be defined in a semantic model to simplify the consumption of a generic function imported from a DAX library:
+```DAX
+    FUNCTION PriceLookup = (
+            search : SCALAR VAL
+        ) =>
+        RangeLookup (
+            search,
+            'Price Range',
+            'Price Range'[Min],
+            'Price Range'[Max],
+            'Price Range'[Range]
+        )
+```
