Skip to content

Commit 8516bbc

Browse files
authored
Update architecture docs (#1709)
1 parent 4ca9d6e commit 8516bbc

Some content is hidden

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

46 files changed

+21445
-105
lines changed

.github/workflows/deploy-docs.yml

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
name: Deploy Docs to GitHub Pages
2+
3+
on:
4+
push:
5+
branches: [main, canary]
6+
paths:
7+
- 'docs-site/**'
8+
- 'docs/**'
9+
workflow_dispatch: # Allow manual trigger
10+
11+
permissions:
12+
contents: read
13+
pages: write
14+
id-token: write
15+
16+
concurrency:
17+
group: pages
18+
cancel-in-progress: false
19+
20+
jobs:
21+
build:
22+
runs-on: ubuntu-latest
23+
steps:
24+
- uses: actions/checkout@v4
25+
26+
- name: Setup Node.js
27+
uses: actions/setup-node@v4
28+
with:
29+
node-version: 22
30+
cache: yarn
31+
cache-dependency-path: docs-site/yarn.lock
32+
33+
- name: Install dependencies
34+
working-directory: docs-site
35+
run: yarn install --frozen-lockfile
36+
37+
- name: Build docs
38+
working-directory: docs-site
39+
run: yarn build
40+
41+
- name: Upload artifact
42+
uses: actions/upload-pages-artifact@v3
43+
with:
44+
path: docs-site/build
45+
46+
deploy:
47+
environment:
48+
name: github-pages
49+
url: ${{ steps.deployment.outputs.page_url }}
50+
runs-on: ubuntu-latest
51+
needs: build
52+
steps:
53+
- name: Deploy to GitHub Pages
54+
id: deployment
55+
uses: actions/deploy-pages@v4
56+

README.md

Lines changed: 22 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,28 @@
66
Forked from [herocast](https://github.com/hellno/herocast/) in April 2024.
77

88
# Docs
9-
Documentation is available in the [docs/](docs/) directory. For online documentation, set `NEXT_PUBLIC_DOCS_URL` environment variable.
9+
10+
Full documentation is available in the [`docs/`](docs/) directory:
11+
12+
- **[Getting Started](docs/GETTING_STARTED.md)** - Quick start guide
13+
- **[Project Structure](docs/PROJECT_STRUCTURE.md)** - Codebase organization
14+
- **[Contributing](docs/CONTRIBUTING.MD)** - How to contribute
15+
16+
### Architecture
17+
- [Overview](docs/ARCHITECTURE/OVERVIEW.md) - System architecture overview
18+
- [Authentication](docs/ARCHITECTURE/AUTHENTICATION.md) - Auth system design
19+
- [State Management](docs/ARCHITECTURE/STATE_MANAGEMENT.md) - Zustand stores
20+
21+
### Systems
22+
- [Configuration](docs/SYSTEMS/CONFIGURATION/ARCHITECTURE_OVERVIEW.md) - Multi-tenant config system
23+
- [Spaces](docs/SYSTEMS/SPACES/OVERVIEW.md) - Space architecture (profile, token, channel, navPage)
24+
- [Fidgets](docs/SYSTEMS/FIDGETS/OVERVIEW.md) - Fidget system and registry
25+
- [Navigation](docs/SYSTEMS/NAVIGATION/OVERVIEW.md) - Navigation system
26+
- [Themes](docs/SYSTEMS/THEMES/OVERVIEW.md) - Theming system
27+
28+
### Integrations
29+
- [Supabase](docs/INTEGRATIONS/SUPABASE.md) - Database schema and storage
30+
- [Farcaster](docs/INTEGRATIONS/FARCASTER.md) - Farcaster integration
1031

1132
## What is Farcaster?
1233
a protocol for decentralized social apps: https://www.farcaster.xyz

docs-site/.gitignore

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Dependencies
2+
/node_modules
3+
4+
# Production
5+
/build
6+
7+
# Generated files
8+
.docusaurus
9+
.cache-loader
10+
11+
# Misc
12+
.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*

docs-site/.yarn/install-state.gz

1.28 MB
Binary file not shown.

docs-site/README.md

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
# Website
2+
3+
This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.
4+
5+
## Installation
6+
7+
```bash
8+
yarn
9+
```
10+
11+
## Local Development
12+
13+
```bash
14+
yarn start
15+
```
16+
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.
18+
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.

docs-site/docs/README.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# Blankspace Documentation
2+
3+
Blankspace is a highly customizable Farcaster client funded by Nouns DAO. Build personalized spaces with themes, tabs, and fidgets.
4+
5+
## Quick Start
6+
7+
- [Getting Started](./getting-started.md) - Local development setup
8+
- [Project Structure](./project-structure.md) - Codebase organization
9+
- [Contributing](./contributing.md) - How to contribute
10+
11+
## Architecture
12+
13+
- [Overview](./architecture/overview.md) - System architecture
14+
- [Authentication](./architecture/authentication.md) - Privy + Farcaster auth
15+
- [State Management](./architecture/state-management.md) - Zustand stores
16+
17+
## Systems
18+
19+
- [Spaces](./systems/spaces.md) - Space architecture
20+
- [Public Spaces](./systems/spaces-public.md) - Public space patterns
21+
- [Fidgets](./systems/fidgets.md) - Fidget system
22+
- [Configuration](./systems/configuration.md) - Multi-tenant config
23+
- [Navigation](./systems/navigation.md) - Navigation system
24+
- [Themes](./systems/themes.md) - Theme system
25+
- [Discovery](./systems/discovery.md) - Mini-app discovery
26+
27+
## Integrations
28+
29+
- [Supabase](./integrations/supabase.md) - Database & storage
30+
- [Farcaster](./integrations/farcaster.md) - Protocol integration
31+
32+
## Development
33+
34+
- [Development Guide](./development/guide.md) - Comprehensive guide
35+
- [Coding Standards](./development/coding-standards.md) - Code style
36+
- [Testing](./development/testing.md) - Testing strategies

0 commit comments

Comments
 (0)