Vocs integration cleanup

README.md

@@ -150,3 +150,60 @@ cpu_air_verifier --in_file=fibonacci_proof.json && echo "Successfully verified e
 ```
 
 This project is supported by Nethermind and Starknet Foundation via [OnlyDust platform](https://app.onlydust.com/p/stone-packaging-)
+
+
+### USNG VOCS TO GENERATE DOCUMENTATION LOCALHOST SITE
+
+We use Vocs to generate our documentation site. Here's how to set it up and run it locally:
+
+### Prerequisites
+
+- Node.js (version 14 or later)
+- Yarn package manager
+
+### Installation
+
+1. Clone the repository:
+   ```bash
+   git clone https://github.com/dipdup-io/stone-packaging.git
+   cd stone-packaging
+   ```
+
+2. Install dependencies:
+   ```bash
+   yarn install
+   ```
+
+### Running the Development Server
+
+To start the development server:
+
+```bash
+yarn dev
+```
+
+This will start the server at `http://localhost:5173`. The site will automatically reload if you make changes to the source files.
+
+### Building the Static Site
+
+To build the static site:
+
+```bash
+yarn build
+```
+
+This will generate the static files in the `dist` directory.
+
+### Project Structure
+
+- `docs/`: Contains all the documentation markdown files.
+- `docs/pages/`: Contains the main content pages.
+- `docs/index.md`: The home page of the documentation.
+- `vocs.config.ts`: Configuration file for Vocs.
+
+### Adding New Pages
+
+To add a new page to the documentation:
+
+1. Create a new markdown file in the `docs/pages/` directory.
+2. Add the new page to the sidebar in `vocs.config.ts`.

docs/404.md

@@ -0,0 +1,8 @@
+---
+title: Page Not Found
+
+---
+
+# 404 - Page Not Found
+
+The page you are looking for does not exist. Please check the URL or go back to the [home page](/).

docs/pages/example.md

@@ -0,0 +1,8 @@
+---
+title: Example
+
+---
+
+# Stone Packaging Example
+
+Here's an example of how to use Stone Packaging...

docs/pages/getting-started.md

@@ -0,0 +1,8 @@
+---
+title: Getting Started
+
+---
+
+# Getting Started with Stone Packaging
+
+...

docs/pages/index.md

@@ -0,0 +1,9 @@
+---
+title: Introduction
+---
+
+# Stone Packaging
+
+This is the main page of Stone Packaging documentation.
+
+Here's an example of how to use Stone Packaging...

package.json

@@ -0,0 +1,19 @@
+{
+  "name": "stone-packaging",
+  "version": "1.0.0",
+  "type": "module",
+  "scripts": {
+    "dev": "vocs dev",
+    "build": "vocs build"
+  },
+  "dependencies": {
+    "vocs": "^1.0.0-alpha.61",
+    "react": "^18.2.0",
+    "react-dom": "^18.2.0"
+  },
+  "devDependencies": {
+    "typescript": "^4.9.5",
+    "@types/react": "^18.0.28",
+    "@types/react-dom": "^18.0.11"
+  }
+}

theme.config.tsx

@@ -0,0 +1,18 @@
+import { defineConfig } from 'vocs'
+
+export default defineConfig({
+  sidebar: [
+    {
+      text: 'Getting Started',
+      link: '/getting-started',
+    },
+    {
+      text: 'Example',
+      link: '/example',
+    },
+    {
+      text: 'Resources',
+      link: '/resources',
+    },
+  ],
+})

tsconfig.json

@@ -0,0 +1,19 @@
+{
+  "compilerOptions": {
+    "esModuleInterop": true,
+    "skipLibCheck": true,
+    "target": "es2022",
+    "allowJs": true,
+    "resolveJsonModule": true,
+    "moduleDetection": "force",
+    "isolatedModules": true,
+    "strict": true,
+    "noUncheckedIndexedAccess": true,
+    "moduleResolution": "node",
+    "module": "esnext",
+    "noEmit": true,
+    "lib": ["es2022", "dom", "dom.iterable"],
+    "types": ["vocs"]
+  },
+  "include": ["vocs.config.ts"]
+}

vocs.config.ts

@@ -0,0 +1,25 @@
+import { defineConfig } from 'vocs'
+
+export default defineConfig({
+  title: 'Stone Packaging',
+  rootDir: 'docs',
+
+  sidebar: [
+    {
+      text: 'Introduction',
+      link: '/',
+    },
+    {
+      text: 'Getting Started',
+      link: '/getting-started',
+    },
+    {
+      text: 'Example',
+      link: '/example',
+    },
+    {
+      text: 'Stone Packaging Resources',
+      link: '/resourcers',
+    },
+  ],
+})

vocs.d.ts

@@ -0,0 +1,3 @@
+declare module 'vocs' {
+  export function defineConfig(config: any): any;
+}