Browse Source

docs(docs): Update manifest ID to 'core' and add README

- Change manifest id from 'oss' to 'core'
- Update name to 'Vendure Core Documentation'
- Add README.md with package overview
- Include README.md in published package files
David Höck 10 hours ago
parent
commit
7148f80bb6
3 changed files with 41 additions and 5 deletions
  1. 35 0
      docs/README.md
  2. 4 3
      docs/package.json
  3. 2 2
      docs/src/manifest.ts

+ 35 - 0
docs/README.md

@@ -0,0 +1,35 @@
+# @vendure/docs
+
+This package contains the official documentation for [Vendure](https://www.vendure.io/), the open-source headless e-commerce framework.
+
+## Overview
+
+The `@vendure/docs` package provides:
+
+- **Guides**: Getting started, core concepts, developer guides, and how-to tutorials
+- **Reference Documentation**: TypeScript API, GraphQL API (Admin & Shop), and plugin documentation
+- **User Guide**: End-user documentation for the Admin UI
+
+## Usage
+
+This package is designed to be consumed by the Vendure documentation platform. It exports a manifest that describes the structure and location of all documentation files.
+
+```typescript
+import { manifest } from '@vendure/docs/manifest';
+```
+
+## Structure
+
+- `docs/` - MDX documentation files organized by category
+- `dist/` - Compiled TypeScript exports
+- `src/manifest.ts` - Documentation manifest defining navigation structure
+
+## Links
+
+- [Vendure Documentation](https://docs.vendure.io/)
+- [Vendure GitHub](https://github.com/vendure-ecommerce/vendure)
+- [Vendure Website](https://www.vendure.io/)
+
+## License
+
+This package is part of the Vendure project and is licensed under the GPL v3 license.

+ 4 - 3
docs/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@vendure/docs",
-    "version": "0.0.0-202601161707",
+    "version": "0.0.0-20260116211406",
     "type": "module",
     "main": "dist/index.js",
     "types": "dist/index.d.ts",
@@ -13,7 +13,8 @@
     },
     "files": [
         "dist",
-        "docs"
+        "docs",
+        "README.md"
     ],
     "scripts": {
         "build": "rimraf dist && tsc -p ./tsconfig.build.json",
@@ -23,7 +24,7 @@
         "typecheck": "tsc"
     },
     "dependencies": {
-        "@vendure-io/docs-provider": "^0.2.0"
+        "@vendure-io/docs-provider": "^0.3.0"
     },
     "devDependencies": {
         "rimraf": "^5.0.5",

+ 2 - 2
docs/src/manifest.ts

@@ -6,8 +6,8 @@ const packageRoot = dirname(dirname(fileURLToPath(import.meta.url)));
 const file = (relativePath: string) => join(packageRoot, relativePath);
 
 export const manifest: DocsPackageManifest = {
-    id: 'oss',
-    name: 'Vendure Documentation',
+    id: 'core',
+    name: 'Vendure Core Documentation',
     version: '3.5.2',
     vendureVersion: 'v3',
     basePath: packageRoot,