Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
49 commits
Select commit Hold shift + click to select a range
df51872
Merge pull request #178 from Super-Protocol/resolve-stg-main-240901
AManilov Sep 2, 2024
415c76b
Merge pull request #181 from Super-Protocol/staging
AManilov Sep 7, 2024
9074811
Merge pull request #184 from Super-Protocol/staging
AManilov Sep 12, 2024
edefaa1
Merge pull request #187 from Super-Protocol/staging
AManilov Oct 10, 2024
e78f1d2
Merge pull request #203 from Super-Protocol/staging
AManilov Nov 21, 2024
c912cfe
Merge pull request #212 from Super-Protocol/staging
AManilov Nov 27, 2024
38d2efe
Merge pull request #215 from Super-Protocol/staging
AManilov Nov 29, 2024
37de9ed
Merge pull request #218 from Super-Protocol/staging
AManilov Nov 29, 2024
bf23cab
Merge pull request #223 from Super-Protocol/develop
AManilov Dec 5, 2024
b6a9a7b
Merge pull request #225 from Super-Protocol/develop
AManilov Dec 11, 2024
04ebad0
Merge pull request #227 from Super-Protocol/develop
AManilov Dec 12, 2024
ddc0bf1
Merge pull request #229 from Super-Protocol/develop
AManilov Dec 19, 2024
51d88a7
Merge pull request #234 from Super-Protocol/staging
Idris0v Dec 20, 2024
3b06b4c
Merge pull request #237 from Super-Protocol/staging
AManilov Dec 26, 2024
4e0560f
Merge pull request #241 from Super-Protocol/staging
AManilov Jan 6, 2025
0f933aa
Merge pull request #244 from Super-Protocol/staging
AManilov Feb 7, 2025
b1ea373
Merge pull request #249 from Super-Protocol/staging
AManilov Feb 14, 2025
7315753
Merge pull request #252 from Super-Protocol/staging
AManilov Feb 19, 2025
6c64e77
Merge pull request #255 from Super-Protocol/staging
AManilov Mar 6, 2025
50659d0
Merge pull request #258 from Super-Protocol/staging
AManilov Mar 11, 2025
5fd1231
Merge pull request #264 from Super-Protocol/staging
AManilov Mar 16, 2025
180470b
Merge pull request #268 from Super-Protocol/staging
AManilov Mar 20, 2025
c206d7f
Merge pull request #273 from Super-Protocol/staging
AManilov Apr 9, 2025
cbaaf99
Merge pull request #279 from Super-Protocol/staging
AManilov Apr 30, 2025
1351d3b
Merge pull request #282 from Super-Protocol/staging
AManilov May 2, 2025
01223ee
Merge pull request #286 from Super-Protocol/staging
Idris0v May 7, 2025
179f441
Merge pull request #291 from Super-Protocol/staging
AManilov May 22, 2025
12a953b
main
k3dz0r Jun 2, 2025
967e70f
Merge pull request #300 from Super-Protocol/staging
AManilov Jun 2, 2025
b2140e3
Merge pull request #304 from Super-Protocol/staging
Idris0v Jun 3, 2025
f04bc98
Merge pull request #309 from Super-Protocol/staging
AManilov Jun 9, 2025
4b87804
Merge pull request #312 from Super-Protocol/staging
AManilov Jun 9, 2025
b8c8d5a
Merge pull request #315 from Super-Protocol/staging
AManilov Jun 11, 2025
5f2519b
Merge pull request #318 from Super-Protocol/staging
AManilov Jun 13, 2025
fa658f5
Merge pull request #321 from Super-Protocol/staging
AManilov Jun 18, 2025
19b3b55
Merge pull request #326 from Super-Protocol/staging
AManilov Jun 19, 2025
7fd5fc4
Merge pull request #331 from Super-Protocol/staging
AManilov Jun 26, 2025
c9a5663
ci(docker-tags): add docker image tag "mainnet" (#332)
pergerk Jul 8, 2025
8c9c042
main
k3dz0r Jul 15, 2025
4161013
Fix guides navigation issue by restructuring guides section
igotstatik Aug 12, 2025
d575526
Create separate Guides section and move guides from marketplace
igotstatik Aug 13, 2025
a53d403
Merge pull request #342 from Super-Protocol/staging
vasilykraev Aug 15, 2025
84272ac
Merge pull request #345 from Super-Protocol/staging
vasilykraev Aug 15, 2025
6595b26
Merge develop branch with new colab section
igotstatik Aug 16, 2025
39ad370
Fix colab documentation: correct sp/outputs to sp/output
igotstatik Aug 16, 2025
a1bce38
Merge pull request #339 from igotstatik/fix/guides-navigation-issue
AgentRX Aug 17, 2025
394ab54
Merge branch 'develop'
AgentRX Aug 18, 2025
b44e888
colab: cli expanded. Guides: pictures relinked
k3dz0r Aug 18, 2025
b6455cc
develop
k3dz0r Aug 19, 2025
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,5 @@ node_modules
**/.DS_Store
.idea
yarn-error.log
ssh.pub
ssh.pub
CLAUDE.md
83 changes: 83 additions & 0 deletions CLAUDE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,83 @@
# CLAUDE.md

This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.

## Overview

This is the documentation website for Super Protocol - a confidential cloud and marketplace for Web3 and AI. The site is built using Docusaurus 2 and contains comprehensive documentation across multiple sections: Marketplace, Fundamentals, CLI, Developers, Whitepaper, and Data-for-AI.

## Common Commands

### Development
- `yarn` or `yarn install` - Install dependencies
- `yarn start` - Start local development server with live reload
- `yarn build` - Build static site for production
- `yarn serve` - Serve the built site locally
- `yarn clear` - Clear Docusaurus cache

### Documentation Generation
- `yarn contracts:gen-docs` - Generate contract documentation from Solidity files
- `yarn write-translations` - Generate translation files
- `yarn write-heading-ids` - Generate heading IDs for documentation

### Other Commands
- `yarn docusaurus <command>` - Direct access to Docusaurus CLI
- `yarn deploy` - Deploy to hosting service
- `yarn swizzle` - Customize Docusaurus components

## Architecture & Structure

### Multi-Instance Documentation Setup
The site uses Docusaurus plugins to create separate documentation instances:
- **Marketplace** (`/marketplace`) - End-user marketplace documentation
- **Fundamentals** (`/fundamentals`) - Core concepts and architecture
- **CLI** (`/cli`) - Command-line interface documentation
- **Developers** (`/developers`) - Developer guides and tutorials (main docs preset)
- **Whitepaper** (`/whitepaper`) - Technical whitepaper and architecture
- **Data-for-AI** (`/data-for-ai`) - AI-specific documentation with custom sidebar

### Key Directories
- `docs/` - Contains all documentation markdown files organized by section
- `src/` - Custom React components and styling
- `src/theme/` - Swizzled Docusaurus components for customization
- `src/css/custom.css` - Global styles
- `static/` - Static assets (images, fonts, etc.)
- `sources/contracts/` - Contract documentation generation tools

### Content Organization
Each documentation section follows a structured approach:
- Index pages provide section overviews and navigation
- Content is organized hierarchically with clear cross-references
- Images are stored in section-specific `images/` folders
- Mathematical formulas use KaTeX rendering

### Custom Components
- **Highlight** - Custom highlighting component
- **Imager** - Custom image handling component
- **Admonition** - Custom alert/warning boxes
- Various swizzled components for styling consistency

### Technical Features
- **Search** - Local search using `@easyops-cn/docusaurus-search-local`
- **Math Support** - KaTeX for mathematical formulas
- **Client Redirects** - Automatic URL redirections
- **Dark/Light Theme** - Custom theme switching
- **Responsive Design** - Mobile-friendly layouts

## Content Guidelines

When working with documentation:
- Use the existing markdown structure and frontmatter format
- Follow the established cross-referencing pattern with custom anchor tags
- Place images in appropriate `images/` subdirectories
- Maintain consistency with existing terminology (offers, orders, providers, TEE, etc.)
- Use KaTeX syntax for mathematical formulas where needed
- Respect the hierarchical organization of content within each section

## Build Process

The CI/CD pipeline runs `yarn build` on pull requests to verify the site builds successfully. The build process includes:
1. Static site generation from markdown files
2. Processing of mathematical formulas with KaTeX
3. Search index generation
4. Asset optimization and bundling
Loading
Loading