Merge pull request #224 from hackdays-io/docs/getstarted

Docs/getstarted

pkgs/document/docs/getstarted/admin/assign-role.md

@@ -0,0 +1,9 @@
+---
+title: 役割を付与
+sidebar_position: 3
+---
+
+# 役割を付与
+
+ユーザー名もしくはウォレットアドレスを指定して、活動に参加しているメンバーに役割を付与していきます。  
+付与した役割はユーザーごとに一時休止と削除ができます。

pkgs/document/docs/getstarted/admin/create-role.md

@@ -0,0 +1,10 @@
+---
+title: 役割を作成
+sidebar_position: 2
+---
+
+# 役割を作成
+
+ワークスペースを作成したら役割を作成します。
+
+役割の詳細はあとからでも変更できます。

pkgs/document/docs/getstarted/admin/create-splitter.md

@@ -0,0 +1,47 @@
+---
+title: トークン（報酬）分配コントラクトを作成
+sidebar_position: 4
+---
+
+# トークン（報酬）分配コントラクトを作成
+
+報酬を分配する役割・メンバーを選択して分配スマートコントラクトを作成します。
+
+## 分配率の計算
+
+分配率は以下の変数と式によって算出される個人ごとのスコアに基づきます。
+
+- 役割の従事期間
+- 役割ごとの係数
+- アシストクレジットの保有率
+
+### 個人のスコア
+
+個人 \(i\) が持つすべての役割についてスコアを合計します：
+
+$$
+\text{個人のスコア}_i = \sum_{j=1}^{m_i} \left( \sqrt{\text{従事期間}_{i,j}} \times \text{役割係数}_{i,j} \times \text{アシストクレジット保有率}_{i,j} \right)
+$$
+
+- mi: 個人 \(i\) が持つ役割の数
+- j: 役割を表すインデックス
+
+※役割を直接持たず、アシストクレジットのみ持っているメンバーの場合は、アシストクレジットをもらったメンバーの従事期間が適用されます。
+
+### 全員のスコアの合計
+
+すべての個人のスコアを合計します：
+
+$$
+\text{全員のスコア合計} = \sum_{i=1}^{n} \text{個人のスコア}_i
+$$
+
+- n: 全体の人数
+
+### 各人の分配率の計算
+
+個人 \(i\) の分配率：
+
+$$
+\text{分配率}_i = \frac{\text{個人のスコア}_i}{\text{全員のスコア合計}}
+$$

pkgs/document/docs/getstarted/admin/create-workspace.md

@@ -0,0 +1,11 @@
+---
+title: ワークスペースを作成
+sidebar_position: 1
+---
+
+# ワークスペースを作成
+
+まず、ワークスペースを作成します。ここで作成するワークスペースは組織やプロジェクト単位のものになります。  
+ワークスペースを作成すると、Toban を扱うために必要な各スマートコントラクトが自動的に作成されます。
+
+ワークスペースの詳細はあとからでも変更できます。

pkgs/document/docs/getstarted/admin/distribute-rewards.md

@@ -0,0 +1,8 @@
+---
+title: 報酬（トークン）を分配
+sidebar_position: 5
+---
+
+# 報酬（トークン）を分配
+
+任意のトークン（ネイティブトークンまたは ERC20 トークン）をまとめて分配コントラクトに送金することで、分配率に応じて自動的に分配されます。

pkgs/document/docs/getstarted/admin/index.md

@@ -0,0 +1,13 @@
+---
+title: 始める（管理者）
+---
+
+# 始める (管理者)
+
+Toban をつかうにあたってのステップ
+
+1. ワークスペースを作成
+2. 役割を作成
+3. 役割を付与
+4. 分配コントラクトを作成
+5. 報酬（トークン）を分配

pkgs/document/docs/getstarted/index.md

@@ -0,0 +1,7 @@
+---
+title: Tobanを始める
+---
+
+# Toban を始める
+
+## ユーザー作成

pkgs/document/docs/getstarted/member/assist-token.md

@@ -0,0 +1,11 @@
+---
+title: アシストトークン
+sidebar_position: 3
+---
+
+# アシストトークン
+
+アシストトークンはすこし手伝ってくれた他のメンバーや、ふらっと現れて助けてくれた人に対してお礼としてわたすことができるトークンです。  
+ユーザー名もしくはウォレットアドレスをつかって送付しあうことができます。
+
+アシストトークンをわたすと、受け取る報酬の一部が渡した相手にも分配されるようになります。

pkgs/document/docs/getstarted/member/check-role.md

@@ -0,0 +1,9 @@
+---
+title: 役割を確認する
+sidebar_position: 2
+---
+
+# 役割を確認する
+
+役割のページには、やらなければならないことや与えられている権限などを確認することができます。  
+役割を一時休止したり、やめたりすることもできます。

pkgs/document/docs/getstarted/member/get-rewards.md

@@ -0,0 +1,11 @@
+---
+title: 報酬を受け取る
+sidebar_position: 4
+---
+
+# 報酬を受け取る
+
+Toban ではネイティブトークン、ERC20 トークンを分配する機能があります。  
+分配を自動的に処理するスマートコントラクトにトークンが送付されるたびに、自動的に受け取ることができます。
+
+分配率の計算式は[こちらを参照してください](/docs/getstarted/admin/create-splitter)。

pkgs/document/docs/getstarted/member/get-role.md

@@ -0,0 +1,9 @@
+---
+title: 役割をもらう
+sidebar_position: 1
+---
+
+# 役割をもらう
+
+ユーザー名もしくはウォレットアドレスを管理者に伝えて、役割を付与してもらいましょう。  
+付与された役割はワークスペースのホーム画面などから確認することができます。

pkgs/document/docs/getstarted/member/index.md

@@ -0,0 +1,12 @@
+---
+title: 始める（メンバー）
+---
+
+# 始める (メンバー)
+
+Toban をつかうにあたってのステップ
+
+1. 役割をもらう
+2. 役割を確認する
+3. アシストトークンをわたす・もらう
+4. 報酬（トークン）を受け取る

pkgs/document/docs/about.md → pkgs/document/docs/welcome.md

@@ -1,8 +1,9 @@
 ---
-title: About Toban
+title: Welcome
+sidebar_position: 1
 ---
 
-# Concept
+# Welcome
 
 Toban is a simplest way to record contribution and distribute rewards.
 

pkgs/document/docusaurus.config.ts

@@ -1,13 +1,15 @@
 import type * as Preset from "@docusaurus/preset-classic";
 import type { Config } from "@docusaurus/types";
 import { themes as prismThemes } from "prism-react-renderer";
+import rehypeKatex from "rehype-katex";
+import remarkMath from "remark-math";
 
 // This runs in Node.js - Don't use client-side code here (browser APIs, JSX...)
 
 const config: Config = {
 	title: "Toban",
 	tagline: "Toban",
-	favicon: "img/favicon.ico",
+	favicon: "img/toban-logo.svg",
 
 	// Set the production url of your site here
 	url: "https://hackdays-io.github.io",
@@ -40,26 +42,36 @@ const config: Config = {
 					// Please change this to your repo.
 					// Remove this to remove the "edit this page" links.
 					editUrl: "https://github.com/hackdays-io/toban",
+					remarkPlugins: [remarkMath],
+					rehypePlugins: [rehypeKatex],
 				},
 				theme: {
 					customCss: "./src/css/custom.css",
 				},
 			} satisfies Preset.Options,
 		],
 	],
-
+	stylesheets: [
+		{
+			href: "https://cdn.jsdelivr.net/npm/[email protected]/dist/katex.min.css",
+			type: "text/css",
+			integrity:
+				"sha384-odtC+0UGzzFL/6PNoE8rX/SPcQDXBJ+uRepguP4QkPCm2LBxH3FA3y+fKSiJ+AmM",
+			crossorigin: "anonymous",
+		},
+	],
 	themeConfig: {
 		// Replace with your project's social card
-		image: "img/logo.png",
+		image: "img/toban-logo.svg",
 		navbar: {
 			title: "Toban",
 			logo: {
 				alt: "Toban Logo",
-				src: "img/logo.png",
+				src: "img/toban-logo.svg",
 			},
 			items: [
 				{
-					to: "/docs/about",
+					to: "/docs/welcome",
 					label: "Docs",
 					position: "left",
 				},
@@ -78,7 +90,7 @@ const config: Config = {
 					items: [
 						{
 							label: "Docs",
-							to: "/docs/about",
+							to: "/docs/welcome",
 						},
 					],
 				},

pkgs/document/package.json

@@ -21,7 +21,9 @@
     "clsx": "^2.0.0",
     "prism-react-renderer": "^2.3.0",
     "react": "^18.0.0",
-    "react-dom": "^18.0.0"
+    "react-dom": "^18.0.0",
+    "rehype-katex": "7",
+    "remark-math": "6"
   },
   "devDependencies": {
     "@docusaurus/module-type-aliases": "3.6.1",

pkgs/document/src/pages/index.tsx

@@ -8,12 +8,11 @@ import Layout from "@theme/Layout";
 export default function Home(): JSX.Element {
 	const { siteConfig } = useDocusaurusContext();
 	return (
-		<Layout
-			title={`${siteConfig.title} Whitepaper`}
-			description="This is a Toban Whitepaper"
-		>
+		<Layout title={`${siteConfig.title}`} description="This is a Toban Docs">
 			<main>
-				<img src="img/banner.png" />
+				<article>
+					<img src="img/banner.png" />
+				</article>
 			</main>
 		</Layout>
 	);