@vendure-io/docs-provider 0.1.0 → 0.1.1

package/README.md

@@ -22,10 +22,18 @@ bun add @vendure-io/docs-provider
 
 ### Defining a Documentation Package Manifest
 
-Documentation packages export a manifest that describes their structure:
+Documentation packages export a manifest that describes their structure. **Important**: File paths must be absolute paths. Use a helper pattern to resolve paths relative to your package root:
 
 ```typescript
 import type { DocsPackageManifest } from '@vendure-io/docs-provider'
+import { dirname, join } from 'path'
+import { fileURLToPath } from 'url'
+
+// Resolve the package root directory at module load time
+const packageRoot = dirname(dirname(fileURLToPath(import.meta.url)))
+
+// Helper to resolve file paths to absolute paths
+const file = (relativePath: string) => join(packageRoot, relativePath)
 
 export const manifest: DocsPackageManifest = {
   id: 'core',
@@ -40,12 +48,12 @@ export const manifest: DocsPackageManifest = {
         {
           title: 'Installation',
           slug: 'installation',
-          file: 'docs/getting-started/installation.mdx',
+          file: file('docs/getting-started/installation.mdx'),
         },
         {
           title: 'Configuration',
           slug: 'configuration',
-          file: 'docs/getting-started/configuration.mdx',
+          file: file('docs/getting-started/configuration.mdx'),
         },
       ],
     },
@@ -54,22 +62,24 @@ export const manifest: DocsPackageManifest = {
     indexFields: ['title', 'description', 'content', 'keywords'],
     boosts: { title: 2, keywords: 1.5 },
   },
+  github: {
+    repository: 'your-org/your-repo',
+    branch: 'main',
+    docsPath: 'libs/your-docs-package',
+  },
 }
 ```
 
-### Loading Documentation Packages
+Your package should export the manifest from a dedicated entry point. Add the following to your `package.json`:
 
-```typescript
-import { loadDocsPackage, loadDocPageBySlug } from '@vendure-io/docs-provider'
-
-// Load a docs package
-const { manifest, basePath } = await loadDocsPackage('@vendure/docs-core')
-
-// Load a specific page by slug
-const page = await loadDocPageBySlug(loadedPackage, 'getting-started/installation')
-if (page) {
-  console.log(page.meta.title) // "Installation"
-  console.log(page.content) // MDX content
+```json
+{
+  "exports": {
+    "./manifest": {
+      "import": "./dist/manifest.js",
+      "types": "./dist/manifest.d.ts"
+    }
+  }
 }
 ```
 
@@ -153,6 +163,7 @@ if (hasFrontmatter(mdxContent)) {
 | `NavigationNode`      | A node in the navigation tree                         |
 | `DocPage`             | A loaded documentation page with metadata and content |
 | `DocPageMeta`         | Frontmatter metadata for a page                       |
+| `ParsedFrontmatter`   | Result of parsing frontmatter (meta + content)        |
 | `SearchConfig`        | Search indexing configuration                         |
 | `VendureVersion`      | Supported Vendure versions (`'v1' \| 'v2' \| 'v3'`)   |
 | `FlatNavigationNode`  | Flattened navigation node with path info              |
@@ -190,16 +201,11 @@ All types have corresponding Zod schemas for runtime validation:
 | `isNodeActive(node, currentPath)`        | Check if node matches path                |
 | `getNodesAtDepth(manifest, depth)`       | Get nodes at specific depth               |
 
-#### Loader Utilities
+#### Navigation Utilities
 
-| Function                               | Description                      |
-| -------------------------------------- | -------------------------------- |
-| `loadDocsPackage(packageName)`         | Load and validate a docs package |
-| `loadDocPage(package, filePath)`       | Load a page by file path         |
-| `loadDocPageBySlug(package, slugPath)` | Load a page by slug path         |
-| `resolveFilePath(package, node)`       | Resolve full file path           |
-| `isDocsPackageInstalled(packageName)`  | Check if package is installed    |
-| `getAllFilePaths(manifest)`            | Get all file paths from manifest |
+| Function                    | Description                      |
+| --------------------------- | -------------------------------- |
+| `getAllFilePaths(manifest)` | Get all file paths from manifest |
 
 #### Frontmatter Utilities
 
@@ -216,7 +222,6 @@ All types have corresponding Zod schemas for runtime validation:
 | ------------------------- | ------------------------------------- |
 | `ManifestValidationError` | Thrown when manifest validation fails |
 | `FrontmatterParseError`   | Thrown when frontmatter parsing fails |
-| `DocsPackageLoadError`    | Thrown when package loading fails     |
 
 ## Development
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vendure-io/docs-provider",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "Contract types and utilities for Vendure documentation packages",
   "private": false,
   "publishConfig": {