@geenius/docs 0.1.0 → 0.4.0

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## 0.4.0
+
+### Minor Changes
+
+- Bring package to A+++ golden-standard compliance with full documentation, cleanup, and structural alignment
+
 All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
@@ -8,4 +14,5 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ## [0.1.0] - 2026-03-20
 
 ### Added
+
 - Initial release

package/README.md

@@ -1 +1,53 @@
-# ✦ geenius-docs\n\n> Geenius Docs — Provider-based documentation system (Astro/Fumadocs/Internal) for React + SolidJS\n\n---\n\n## Overview\nBuilt with Steve Jobs-level minimalism and Jony Ive-level craftsmanship, this package is designed to deliver unparalleled developer experience (DX) and rock-solid performance.\n\n## Installation\n\n```bash\npnpm add geenius-docs\n```\n\n## Usage\n\n```typescript\nimport { init } from 'geenius-docs';\n\n// Initialize the module with absolute precision\ninit({\n  mode: 'premium',\n});\n```\n\n## Architecture\n- **Zero-config**: It just works.\n- **Strictly Typed**: Fully written in TypeScript for flawless IntelliSense.\n- **Framework Agnostic**: seamlessly integrates into the Geenius ecosystem.\n\n---\n\n*Designed by Antigravity HQ*\n
+# `@geenius/docs`
+
+Provider-driven documentation primitives for Geenius products, including navigation, search, MDX rendering, and admin-oriented docs tooling.
+
+## Install
+
+```bash
+pnpm add @geenius/docs
+```
+
+## Supported Imports
+
+- `@geenius/docs` or `@geenius/docs/shared` for shared page, section, and search types plus provider contracts
+- `@geenius/docs/react` for React hooks, components, and page-level shells
+- `@geenius/docs/react-css` for the React CSS-styled surface
+- `@geenius/docs/solidjs` for SolidJS primitives, components, and pages
+- `@geenius/docs/solidjs-css` for the SolidJS CSS-styled surface
+- `@geenius/docs/convex` for Convex-backed docs storage helpers
+
+## Quick Start
+
+```tsx
+import type { DocPage as DocsPage } from '@geenius/docs'
+import { DocPage } from '@geenius/docs/react'
+
+const page: DocsPage = {
+  id: 'intro',
+  title: 'Introduction',
+  slug: 'introduction',
+  content: '# Introduction\n\nWelcome to the docs.',
+  sectionId: 'getting-started',
+  order: 1,
+  author: { name: 'Antigravity HQ' },
+  access: 'public',
+  tags: ['overview'],
+  status: 'published',
+  createdAt: '2026-04-12T09:00:00.000Z',
+  updatedAt: '2026-04-12T09:00:00.000Z',
+  wordCount: 120,
+  readingTime: 1,
+  viewCount: 42,
+}
+
+export function IntroDoc() {
+  return <DocPage page={page} />
+}
+```
+
+## Local Development
+
+- `pnpm storybook:react` runs the React storybook app
+- `pnpm storybook:solidjs` runs the SolidJS storybook app
+- Storybook apps live under `apps/` and are development-only; they are not part of the published contract

package/package.json

@@ -1,10 +1,15 @@
 {
   "name": "@geenius/docs",
+  "version": "0.4.0",
   "type": "module",
-  "version": "0.1.0",
-  "description": "Geenius Docs — Provider-based documentation system (Astro/Fumadocs/Internal) for React + SolidJS",
-  "author": "Antigravity HQ",
+  "description": "Geenius Docs — Provider-based documentation primitives and Storybook review apps for React, SolidJS, and Convex.",
+  "author": "Mehdi Nabhani",
   "license": "MIT",
+  "sideEffects": false,
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/geenius-dev/geenius-docs.git"
+  },
   "keywords": [
     "docs",
     "documentation",
@@ -13,12 +18,51 @@
     "fumadocs",
     "react",
     "solidjs",
+    "convex",
     "geenius"
   ],
-  "scripts": {
-    "build": "pnpm -r build",
-    "clean": "pnpm -r clean",
-    "type-check": "pnpm -r type-check"
+  "files": [
+    "packages/shared/dist",
+    "packages/react/dist",
+    "packages/react-css/dist",
+    "packages/solidjs/dist",
+    "packages/solidjs-css/dist",
+    "packages/convex/dist",
+    "README.md",
+    "LICENSE",
+    "CHANGELOG.md"
+  ],
+  "dependencies": {
+    "@geenius/motion": "0.2.0",
+    "@geenius/tools": "0.3.0"
+  },
+  "peerDependencies": {
+    "convex": ">=1.34.0",
+    "react": ">=18.0.0",
+    "react-dom": ">=18.0.0",
+    "solid-js": ">=1.8.0"
+  },
+  "peerDependenciesMeta": {
+    "convex": {
+      "optional": true
+    },
+    "react": {
+      "optional": true
+    },
+    "react-dom": {
+      "optional": true
+    },
+    "solid-js": {
+      "optional": true
+    }
+  },
+  "devDependencies": {
+    "@arethetypeswrong/cli": "^0.18.2",
+    "@biomejs/biome": "^2.0.6",
+    "@changesets/cli": "^2.30.0",
+    "publint": "^0.3.18",
+    "typescript": "~6.0.2",
+    "vitest": "^4.1.4"
   },
   "engines": {
     "node": ">=20.0.0"
@@ -32,10 +76,6 @@
       "types": "./packages/shared/dist/index.d.ts",
       "import": "./packages/shared/dist/index.js"
     },
-    "./convex": {
-      "types": "./packages/convex/dist/index.d.ts",
-      "import": "./packages/convex/dist/index.js"
-    },
     "./react": {
       "types": "./packages/react/dist/index.d.ts",
       "import": "./packages/react/dist/index.js"
@@ -51,8 +91,51 @@
     "./solidjs-css": {
       "types": "./packages/solidjs-css/dist/index.d.ts",
       "import": "./packages/solidjs-css/dist/index.js"
+    },
+    "./convex": {
+      "types": "./packages/convex/dist/index.d.ts",
+      "import": "./packages/convex/dist/index.js"
+    }
+  },
+  "typesVersions": {
+    "*": {
+      "shared": [
+        "./packages/shared/dist/index.d.ts"
+      ],
+      "react": [
+        "./packages/react/dist/index.d.ts"
+      ],
+      "react-css": [
+        "./packages/react-css/dist/index.d.ts"
+      ],
+      "solidjs": [
+        "./packages/solidjs/dist/index.d.ts"
+      ],
+      "solidjs-css": [
+        "./packages/solidjs-css/dist/index.d.ts"
+      ],
+      "convex": [
+        "./packages/convex/dist/index.d.ts"
+      ]
     }
   },
   "main": "./packages/shared/dist/index.js",
-  "types": "./packages/shared/dist/index.d.ts"
-}
+  "types": "./packages/shared/dist/index.d.ts",
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "changeset": "changeset",
+    "build": "pnpm --filter ./packages/shared build && pnpm -r --filter './packages/*' --filter '!./packages/shared' build",
+    "lint": "pnpm exec biome check . && pnpm --filter ./packages/shared type-check && pnpm -r --filter './packages/*' --filter '!./packages/shared' type-check",
+    "type-check": "pnpm --filter ./packages/shared type-check && pnpm -r --filter './packages/*' --filter '!./packages/shared' type-check",
+    "test:unit": "pnpm -r --filter './packages/*' test && vitest run __tests__/parity.test.ts",
+    "test:exports": "vitest run __tests__/exports.test.ts --passWithNoTests",
+    "test:types": "pnpm exec tsc -p tsconfig.type-tests.json --noEmit && npm_config_cache=/tmp/.npm-cache attw --pack --ignore-rules cjs-resolves-to-esm",
+    "test": "pnpm build && pnpm run test:unit && pnpm run test:exports && pnpm run test:types",
+    "clean": "pnpm -r --filter './packages/*' clean",
+    "storybook:react": "pnpm --filter @geenius/docs-storybook-react dev",
+    "storybook:solidjs": "pnpm --filter @geenius/docs-storybook-solidjs dev",
+    "lint:pub": "publint"
+  }
+}