Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
46 changes: 46 additions & 0 deletions .github/workflows/deploy.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
name: Deploy to GitHub Pages

on:
push:
branches:
- main

jobs:
build:
name: Build Docusaurus
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
with:
fetch-depth: 0

- uses: actions/setup-node@v4
with:
node-version: 20
cache: npm

- name: Install dependencies
run: npm ci

- name: Build website
run: npm run build

- name: Upload Build Artifact
uses: actions/upload-pages-artifact@v3
with:
path: build

deploy:
name: Deploy to GitHub Pages
needs: build
permissions:
pages: write
id-token: write
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4
80 changes: 26 additions & 54 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,69 +1,41 @@
# 🐋 CrowdWalrus Documentation
# Website

Welcome to the official documentation hub for **CrowdWalrus** — a decentralized, censorship-resistant crowdfunding platform built on **Sui** and **Walrus Site**.
This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.

This repository is **for documentation only** — covering product design, user flows, technical architecture, and scoping.
## Installation

🎨 For branding, visit 👉 [CrowdWalrus/brand-assets](https://github.com/CrowdWalrus/brand-assets)
```bash
yarn
```

---
## Local Development

## 📚 Table of Contents
```bash
yarn start
```

### 1. 🚀 Introduction
- [🌟 Product Overview, Purpose and Vision](./Product-Overview-Purpose-Vision.md)
- [Projects vs Campaigns](./Understanding-Projects-Campaigns-Differences.md)
- [👤 User Personas](./User%20Personas.md)
- [🤝 Target Audiences](./TargetAudiences.md)
- [✅ Verification Process](./VerificationProcess.md)
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

---
## Build

### 2. 📐 Product Scoping
- [📄 Original Proposal](./OriginalProposal.md)
- [📄 Detailed MVP Scope](./MVP-scope.md)
- ✨ *Planned:* [Roadmap], [Changelog], [FAQ]
```bash
yarn build
```

---
This command generates static content into the `build` directory and can be served using any static contents hosting service.

### 3. 🏛 Architecture & Tech Research
- [🖥 Software Architecture](./Software_Architecture.md)
- [🎨 Frontend Architecture & Tools](./Frontend%20Architecture%20%26%20Tools.md)
- ✨ *Planned:* Smart Contracts, Data Model, Audit
## Deployment

---
Using SSH:

### 4. 🔄 User Flows
- [👨‍💼 Admin Flow](./UserFlow-Admin.md)
- [📂 Project Owner Flow](./UserFlow-ProjectOwner.md)
- [🛡 Project Moderator Flow](./UserFlow-ProjectModerator.md)
- [🎯 Campaign Owner Flow](./UserFlow-CampaignOwner.md)
- [💝 Backer/Donor Flow](./UserFlow-Backer-Donor.md)
- ✨ *Planned:* Sequence Diagrams, Edge Cases
```bash
USE_SSH=true yarn deploy
```

---
Not using SSH:

### 5. 💸 Economics & Rewards
- [⚖️ Financial Split Models](./Financial-Split-Models.md)
- [🎁 NFT Reward Mechanism](./NFT-Reward-Mechanism.md)
- ✨ *Planned:* QF, Tokenomics, Incentive Design
```bash
GIT_USER=<Your GitHub username> yarn deploy
```

---

### 6. 🛡 Governance & Policy
- [✅ Verification Process](./VerificationProcess.md)
- ✨ *Planned:* Content Policy, Listing Policy, Trust & Safety, Privacy & Data

---

## 📂 Other Resources
- 🎨 [Brand Assets](https://github.com/CrowdWalrus/brand-assets)
- 📑 MVP Scoping PDFs (original source docs):


---

## 📜 License
> To be added (suggested: **CC BY-SA 4.0** for documentation).
# Docs
CrowdWalrus Documentation for Product, Tech, UI/UX, Tests, Team Management, CI/CD, and everything related
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.
12 changes: 12 additions & 0 deletions blog/2019-05-28-first-blog-post.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
---
slug: first-blog-post
title: First Blog Post
authors: [slorber, yangshun]
tags: [hola, docusaurus]
---

Lorem ipsum dolor sit amet...

<!-- truncate -->

...consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
44 changes: 44 additions & 0 deletions blog/2019-05-29-long-blog-post.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
---
slug: long-blog-post
title: Long Blog Post
authors: yangshun
tags: [hello, docusaurus]
---

This is the summary of a very long blog post,

Use a `<!--` `truncate` `-->` comment to limit blog post size in the list view.

<!-- truncate -->

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
24 changes: 24 additions & 0 deletions blog/2021-08-01-mdx-blog-post.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
---
slug: mdx-blog-post
title: MDX Blog Post
authors: [slorber]
tags: [docusaurus]
---

Blog posts support [Docusaurus Markdown features](https://docusaurus.io/docs/markdown-features), such as [MDX](https://mdxjs.com/).

:::tip

Use the power of React to create interactive blog posts.

:::

{/* truncate */}

For example, use JSX to create an interactive button:

```js
<button onClick={() => alert('button clicked!')}>Click me!</button>
```

<button onClick={() => alert('button clicked!')}>Click me!</button>
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
29 changes: 29 additions & 0 deletions blog/2021-08-26-welcome/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
---
slug: welcome
title: Welcome
authors: [slorber, yangshun]
tags: [facebook, hello, docusaurus]
---

[Docusaurus blogging features](https://docusaurus.io/docs/blog) are powered by the [blog plugin](https://docusaurus.io/docs/api/plugins/@docusaurus/plugin-content-blog).

Here are a few tips you might find useful.

<!-- truncate -->

Simply add Markdown files (or folders) to the `blog` directory.

Regular blog authors can be added to `authors.yml`.

The blog post date can be extracted from filenames, such as:

- `2019-05-30-welcome.md`
- `2019-05-30-welcome/index.md`

A blog post folder can be convenient to co-locate blog post images:

![Docusaurus Plushie](./docusaurus-plushie-banner.jpeg)

The blog supports tags as well!

**And if you don't want a blog**: just delete this directory, and use `blog: false` in your Docusaurus config.
25 changes: 25 additions & 0 deletions blog/authors.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
yangshun:
name: Yangshun Tay
title: Ex-Meta Staff Engineer, Co-founder GreatFrontEnd
url: https://linkedin.com/in/yangshun
image_url: https://github.com/yangshun.png
page: true
socials:
x: yangshunz
linkedin: yangshun
github: yangshun
newsletter: https://www.greatfrontend.com

slorber:
name: Sébastien Lorber
title: Docusaurus maintainer
url: https://sebastienlorber.com
image_url: https://github.com/slorber.png
page:
# customize the url of the author page at /blog/authors/<permalink>
permalink: '/all-sebastien-lorber-articles'
socials:
x: sebastienlorber
linkedin: sebastienlorber
github: slorber
newsletter: https://thisweekinreact.com
19 changes: 19 additions & 0 deletions blog/tags.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
facebook:
label: Facebook
permalink: /facebook
description: Facebook tag description

hello:
label: Hello
permalink: /hello
description: Hello tag description

docusaurus:
label: Docusaurus
permalink: /docusaurus
description: Docusaurus tag description

hola:
label: Hola
permalink: /hola
description: Hola tag description
23 changes: 23 additions & 0 deletions docs/campaign-owners/campaign-deactivation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# Campaign Deactivation

Deactivation stops fundraising while keeping the page up.

## When to deactivate
- You delivered the milestones, impact, rewards
- You want to pause donations or contributions
- You discovered an issue and need to regroup

## What happens after deactivation

- Campaign status shows as ended
- Donations are disabled
- Updates remain readable

## Can I reactivate?
- Reactivation are always possible
- Campaigns will get back to normal mode, like active, funding ...
- Campaign owner can post updates again.

---

Next: [Campaign Deletion](./campaign-deletion.md)
20 changes: 20 additions & 0 deletions docs/campaign-owners/campaign-deletion.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Campaign Deletion

Deletion is the “hard stop.”

## What deletion means in a blockchain app
On-chain history still exists, but the campaign is marked as deleted.

In practice:
- it disappears from discovery
- editing and donating are disabled

## When to delete
- You created a campaign by mistake
- You want it permanently removed from the app’s public surfaces

⚠️ Deletion is usually irreversible.

---

Next: [Campaign SuiNS Subname](./campaign-suins-subname.md)
Loading