Cofhe docs

package.json

@@ -16,10 +16,10 @@
   },
   "dependencies": {
     "@cookbookdev/docsbot": "^4.21.5",
-    "@docusaurus/core": "^3.4.0",
-    "@docusaurus/plugin-sitemap": "^3.4.0",
-    "@docusaurus/preset-classic": "^3.4.0",
-    "@docusaurus/theme-common": "^3.4.0",
+    "@docusaurus/core": "^3.7.0",
+    "@docusaurus/plugin-sitemap": "^3.7.0",
+    "@docusaurus/preset-classic": "^3.7.0",
+    "@docusaurus/theme-common": "^3.7.0",
     "@mdx-js/react": "^3.0.0",
     "clsx": "^2.0.0",
     "pnpm": "^9.1.4",

versioned_docs/version-CoFHE/_planning/cofhe_layout.md

@@ -0,0 +1,99 @@
+# Developer Documentation 👨‍💻
+
+## 📋 Overview
+1. What is CoFHE
+2. Main Features
+3. Uses
+4. CTA: Getting Started Guide
+
+## 🏗️ Architecture
+> Includes comprehensive diagram with table content
+
+### User-Facing Utilities
+- CoFHE.js
+- FHE.sol
+
+### Internal Utilities
+- TaskManager
+- ACL
+- Aggregator
+- CTRegistry
+- Verifier
+- FheOs - Server
+- Threshold Network
+  - ZKPoK
+
+### Data Flows
+```mermaid
+graph LR
+    A[Encryption Request] --> B[FHE Operation]
+    B --> C[Decryption Request]
+    C --> D[Decrypt/SealOutput]
+```
+
+- Encryption Request Flow
+- Request for FHE Operation
+- Decryption Request
+- Decrypt/SealOutput from FhenixJS
+
+## 🔧 CoFHE.JS
+> Including GitHub Repository Links
+
+
+### **Installation Guide** (Setup Only)
+### **Encryption Operations**
+### **Sealing & Unsealing**
+### **Permits Management**
+### **Getting Started**
+### **End-to-End Example**
+### **Network Keys**
+### **Error Handling**
+
+## 📘 FHE Library (FHE.sol)
+> Including GitHub Repository Links (CoFHE-Contracts)
+
+### **Inputs**
+### **Outputs**
+   - Events
+   - Returned Results
+### **FHE Encrypted Operations**
+### **Select vs If...else**
+### **ACL Mechanism**
+### **Randomness**
+### **Decryption Operations**
+### **Security Zones**
+### **Gas and Benchmarks** 
+    -At risk
+
+## 💎 FHERC20
+    - At risk 
+    - Standard Implementation
+    - Custom Features
+
+## 📝 Tutorials
+### **Getting Started**
+### **Your First Confidential Smart Contract**
+### **Migrating to CoFHE**
+### **Local Development Setup**
+    - W+ Threshold Network
+    - W/o Threshold Network
+### **Testing and Logging**
+### **ACL Usage Examples**
+### **Best Practices**
+
+## 🛠️ SDK (Out of Scope)
+- CoFHE.js Integration
+- Browser-based Wallet SDK
+- Browser-based Wallet UI Layout
+
+## ⚠️Pay Attention
+> Critical limitations and important considerations
+
+### Common Issues
+- FHE.sol Usage Problems
+- Known Limitations
+- Troubleshooting Guide
+
+## Research and Publications
+
+## Future Plans

versioned_docs/version-CoFHE/devdocs/_category_.json

@@ -0,0 +1,8 @@
+{
+  "label": "Developer Documentation",
+  "position": 1,
+  "link": {
+    "type": "generated-index",
+    "description": "Complete developer documentation for CoFHE"
+  }
+} 

versioned_docs/version-CoFHE/devdocs/architecture/_category_.json

@@ -0,0 +1,8 @@
+{
+  "label": "Architecture",
+  "position": 2,
+  "link": {
+    "type": "generated-index",
+    "description": "Comprehensive overview of CoFHE architecture and components"
+  }
+} 

versioned_docs/version-CoFHE/devdocs/architecture/user-facing-utilities.md

@@ -0,0 +1,13 @@
+---
+title: User-Facing Utilities
+sidebar_position: 1
+description: Overview of CoFHE.js and FHE.sol utilities
+---
+
+# User-Facing Utilities
+
+## CoFHE.js
+[Description of CoFHE.js utility]
+
+## FHE.sol
+[Description of FHE.sol utility]

versioned_docs/version-CoFHE/devdocs/cofhejs/_category_.json

@@ -0,0 +1,8 @@
+{
+  "label": "CoFHE.JS",
+  "position": 3,
+  "link": {
+    "type": "generated-index",
+    "description": "Documentation for the CoFHE JavaScript library"
+  }
+} 

versioned_docs/version-CoFHE/devdocs/fhe-library/_category_.json

@@ -0,0 +1,8 @@
+{
+  "label": "FHE Library (FHE.sol)",
+  "position": 4,
+  "link": {
+    "type": "generated-index",
+    "description": "Documentation for the core FHE Solidity library"
+  }
+} 

versioned_docs/version-CoFHE/devdocs/fherc20/_category_.json

@@ -0,0 +1,8 @@
+{
+  "label": "FHERC20",
+  "position": 5,
+  "link": {
+    "type": "generated-index",
+    "description": "Documentation for the confidential token standard"
+  }
+} 

versioned_docs/version-CoFHE/devdocs/fherc20/custom-features.md

@@ -0,0 +1,8 @@
+---
+title: Custom Features
+sidebar_position: 3
+---
+
+# Custom Features
+
+Extended features and customizations available in FHERC20. 

versioned_docs/version-CoFHE/devdocs/fherc20/index.md

@@ -0,0 +1,8 @@
+---
+title: FHERC20 Token Standard
+sidebar_position: 1
+---
+
+# FHERC20 Token Standard
+
+Welcome to the FHERC20 documentation section. Here you'll learn about the confidential token standard implementation in CoFHE.

versioned_docs/version-CoFHE/devdocs/fherc20/risk-considerations.md

@@ -0,0 +1,8 @@
+---
+title: Risk Considerations
+sidebar_position: 4
+---
+
+# Risk Considerations
+
+Important security and risk considerations when implementing FHERC20. 

versioned_docs/version-CoFHE/devdocs/fherc20/standard-implementation.md

@@ -0,0 +1,8 @@
+---
+title: Standard Implementation
+sidebar_position: 2
+---
+
+# Standard Implementation
+
+Details about the standard FHERC20 implementation. 

versioned_docs/version-CoFHE/devdocs/future-plans/_category_.json

@@ -0,0 +1,8 @@
+{
+  "label": "Future Plans",
+  "position": 9,
+  "link": {
+    "type": "generated-index",
+    "description": "Upcoming features and roadmap"
+  }
+} 

versioned_docs/version-CoFHE/devdocs/overview/_category_.json

@@ -0,0 +1,8 @@
+{
+  "label": "Overview",
+  "position": 1,
+  "link": {
+    "type": "generated-index",
+    "description": "Basic concepts and introduction to CoFHE"
+  }
+} 

versioned_docs/version-CoFHE/devdocs/overview/index.md

@@ -0,0 +1,8 @@
+---
+title: Overview
+sidebar_position: 1
+---
+
+# Overview
+
+Welcome to the CoFHE documentation. This section provides a comprehensive overview of CoFHE, its features, and use cases. 

versioned_docs/version-CoFHE/devdocs/overview/main-features.md

@@ -0,0 +1,9 @@
+---
+title: Main Features
+sidebar_position: 2
+description: Key features and capabilities of CoFHE
+---
+
+# Main Features
+
+[Content about main features]

versioned_docs/version-CoFHE/devdocs/overview/what-is-cofhe.md

@@ -0,0 +1,9 @@
+---
+title: What is CoFHE
+sidebar_position: 1
+description: Introduction to CoFHE and its core concepts
+---
+
+# What is CoFHE
+
+[Content about CoFHE introduction] 

versioned_docs/version-CoFHE/devdocs/pay-attention/_category_.json

@@ -0,0 +1,8 @@
+{
+  "label": "⚠️ Important Notes",
+  "position": 8,
+  "link": {
+    "type": "generated-index",
+    "description": "Critical limitations and important considerations"
+  }
+} 

versioned_docs/version-CoFHE/devdocs/research-and-publications/_category_.json

@@ -0,0 +1,8 @@
+{
+  "label": "Research and Publications",
+  "position": 10,
+  "link": {
+    "type": "generated-index",
+    "description": "Academic research and publications related to CoFHE"
+  }
+} 

versioned_docs/version-CoFHE/devdocs/research-and-publications/index.md

@@ -0,0 +1,21 @@
+---
+title: Research and Publications
+sidebar_position: 1
+description: Academic research and publications related to CoFHE
+---
+
+# Research and Publications
+
+This section contains academic research, technical papers, and publications related to CoFHE and its underlying technologies.
+
+## Academic Papers
+
+[List of academic papers will be added here]
+
+## Technical Publications
+
+[List of technical publications will be added here]
+
+## Research Collaborations
+
+[Information about research collaborations will be added here] 

versioned_docs/version-CoFHE/devdocs/sdk/_category_.json

@@ -0,0 +1,8 @@
+{
+  "label": "SDK (Out of Scope)",
+  "position": 7,
+  "link": {
+    "type": "generated-index",
+    "description": "Integration guides for CoFHE SDKs (currently out of scope)"
+  }
+} 

versioned_docs/version-CoFHE/devdocs/sdk/browser-wallet-sdk.md

@@ -0,0 +1,8 @@
+---
+title: Browser Wallet SDK
+sidebar_position: 3
+---
+
+# Browser Wallet SDK
+
+Documentation for the browser-based wallet SDK. 

versioned_docs/version-CoFHE/devdocs/sdk/browser-wallet-ui.md

@@ -0,0 +1,8 @@
+---
+title: Browser Wallet UI
+sidebar_position: 4
+---
+
+# Browser Wallet UI
+
+Documentation for the browser-based wallet UI layout and components. 

versioned_docs/version-CoFHE/devdocs/sdk/cofhejs-integration.md

@@ -0,0 +1,8 @@
+---
+title: CoFHE.js Integration
+sidebar_position: 2
+---
+
+# CoFHE.js Integration
+
+Guide for integrating CoFHE.js into your applications. 

versioned_docs/version-CoFHE/devdocs/sdk/index.md

@@ -0,0 +1,8 @@
+---
+title: SDK Integration
+sidebar_position: 1
+---
+
+# SDK Integration
+
+This section covers SDK integration topics (currently out of scope).

versioned_docs/version-CoFHE/devdocs/tutorials/_category_.json

@@ -0,0 +1,8 @@
+{
+  "label": "Tutorials",
+  "position": 6,
+  "link": {
+    "type": "generated-index",
+    "description": "Step-by-step guides and examples for working with CoFHE"
+  }
+} 

versioned_sidebars/version-CoFHE-sidebars.json

@@ -0,0 +1,8 @@
+{
+  "docsSidebar": [
+    {
+      "type": "autogenerated",
+      "dirName": "devdocs"
+    }
+  ]
+}

versions.json

@@ -1,3 +1,4 @@
 [
+  "CoFHE",
   "Helium"
 ]