Skip to content

Commit 3215549

Browse files
0xZuniaclaude
andcommitted
Add Docusaurus 3 documentation site with 25 pages
Complete documentation site covering all Basalt subsystems: - Getting Started (installation, quickstart, architecture) - Core Concepts (consensus, cryptography, networking, storage, execution) - Smart Contracts (overview, tutorial, SDK reference, token standards, analyzers, testing) - Node Operations (running a node, configuration, Docker devnet, staking) - APIs (REST, gRPC, GraphQL) - CLI reference, EVM Bridge, and Compliance - Full design plan and technical spec in specifications/ Includes Docusaurus config, custom homepage, GitHub Pages deployment workflow, and Basalt-branded theme. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1 parent 7ec32ab commit 3215549

46 files changed

Lines changed: 24654 additions & 10 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.github/workflows/deploy.yml

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
name: Deploy to GitHub Pages
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
8+
permissions:
9+
contents: read
10+
pages: write
11+
id-token: write
12+
13+
concurrency:
14+
group: "pages"
15+
cancel-in-progress: false
16+
17+
jobs:
18+
build:
19+
runs-on: ubuntu-latest
20+
steps:
21+
- uses: actions/checkout@v4
22+
23+
- uses: actions/setup-node@v4
24+
with:
25+
node-version: 20
26+
cache: npm
27+
28+
- name: Install dependencies
29+
run: npm ci
30+
31+
- name: Build website
32+
run: npm run build
33+
34+
- name: Upload artifact
35+
uses: actions/upload-pages-artifact@v3
36+
with:
37+
path: build
38+
39+
deploy:
40+
environment:
41+
name: github-pages
42+
url: ${{ steps.deployment.outputs.page_url }}
43+
runs-on: ubuntu-latest
44+
needs: build
45+
steps:
46+
- name: Deploy to GitHub Pages
47+
id: deployment
48+
uses: actions/deploy-pages@v4

.gitignore

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,20 @@
1+
# Dependencies
2+
/node_modules
3+
4+
# Production
5+
/build
6+
7+
# Generated files
8+
.docusaurus
9+
.cache-loader
10+
11+
# Misc
112
.DS_Store
13+
.env.local
14+
.env.development.local
15+
.env.test.local
16+
.env.production.local
17+
18+
npm-debug.log*
19+
yarn-debug.log*
20+
yarn-error.log*

README.md

Lines changed: 34 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,41 @@
1-
# Basalt Documentation
1+
# Website
22

3-
Technical documentation, design plans, and specifications for the Basalt blockchain.
3+
This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.
44

5-
## Contents
5+
## Installation
66

7-
- **[Design Plan](basalt_design_plan.md)** — Architecture overview, protocol design, and roadmap
8-
- **[Technical Specification](basalt_technical_spec.docx.md)** — Detailed technical specification
7+
```bash
8+
yarn
9+
```
910

10-
## Related
11+
## Local Development
1112

12-
- [Main Repository](https://github.com/Basalt-Foundation/basalt) — Source code
13-
- [Solidity Contracts](https://github.com/Basalt-Foundation/basalt-contracts) — EVM bridge contracts
13+
```bash
14+
yarn start
15+
```
1416

15-
## License
17+
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
1618

17-
[Apache License 2.0](https://github.com/Basalt-Foundation/basalt/blob/main/LICENSE)
19+
## Build
20+
21+
```bash
22+
yarn build
23+
```
24+
25+
This command generates static content into the `build` directory and can be served using any static contents hosting service.
26+
27+
## Deployment
28+
29+
Using SSH:
30+
31+
```bash
32+
USE_SSH=true yarn deploy
33+
```
34+
35+
Not using SSH:
36+
37+
```bash
38+
GIT_USER=<Your GitHub username> yarn deploy
39+
```
40+
41+
If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.

0 commit comments

Comments
 (0)