Skip to content

Commit

Permalink
[whitepaper] migrate white paper here. (#242)
Browse files Browse the repository at this point in the history
  • Loading branch information
dantaik authored Nov 10, 2022
1 parent faba2b2 commit 305df91
Show file tree
Hide file tree
Showing 16 changed files with 983 additions and 6 deletions.
1 change: 1 addition & 0 deletions .github/workflows/solidity.yml
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ jobs:
- uses: actions/setup-node@v3
with:
node-version: "16.15"

- uses: pnpm/action-setup@v2
name: Install pnpm
id: pnpm-install
Expand Down
1 change: 1 addition & 0 deletions .github/workflows/website.yml
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ jobs:
- uses: actions/setup-node@v3
with:
node-version: "16.15"

- uses: pnpm/action-setup@v2
name: Install pnpm
id: pnpm-install
Expand Down
37 changes: 37 additions & 0 deletions .github/workflows/whitepaper.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
name: Whitepaper
on:
push:
branches: [main]
paths:
- "packages/whitepaper/**"
pull_request:
paths:
- "packages/whitepaper/**"
jobs:
build_latex:
runs-on: ubuntu-latest
steps:
- name: Cancel Previous Runs
uses: styfle/cancel-workflow-action@0.11.0
with:
access_token: ${{ github.token }}

- uses: actions/checkout@v3
- uses: actions/setup-node@v3
with:
node-version: "16.15"

- name: Compile main.tex
uses: xu-cheng/latex-action@v2
with:
working_directory: ./packages/whitepaper
root_file: main.tex

- name: Rename
working-directory: ./packages/whitepaper
run: mkdir -p build && mv main.pdf build/taiko-whitepaper.pdf

- name: Deploy to GitHub Pages
uses: JamesIves/github-pages-deploy-action@v4
with:
folder: ./packages/whitepaper/build
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@
- [branding](./packages/branding/): branding materials
- [protocol](./packages/protocol/): L1 and L2 smart contracts
- [website](./packages/website/): main documentation website
- [whitepaper](./packages/whitepaper): Latex source files for Taiko's whitepaper. A PDF will be published automatically to: https://taikochain.github.io/taiko-mono/taiko-whitepaper.pdf (linked from https://taiko.xyz).

## Github Actions

Expand Down
3 changes: 1 addition & 2 deletions packages/website/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,11 @@
"version": "0.0.0",
"private": true,
"scripts": {
"build": "pnpm import:whitepaper && docusaurus build",
"build": "docusaurus build",
"clear": "docusaurus clear",
"deploy": "docusaurus deploy",
"docusaurus": "docusaurus",
"import:docs": "./scripts/import-docs.sh",
"import:whitepaper": "./scripts/import-whitepaper.sh",
"serve": "docusaurus serve",
"start": "docusaurus start",
"swizzle": "docusaurus swizzle",
Expand Down
3 changes: 0 additions & 3 deletions packages/website/scripts/import-whitepaper.sh

This file was deleted.

2 changes: 1 addition & 1 deletion packages/website/src/pages/index.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ function HomepageHeader() {
<div className={styles.buttons}>
<a
className="button button--secondary button--lg"
href="./taiko-whitepaper.pdf"
href="https://taikochain.github.io/taiko-mono/taiko-whitepaper.pdf"
target="_blank"
>
Read the whitepaper
Expand Down
Binary file removed packages/website/static/taiko-whitepaper.pdf
Binary file not shown.
3 changes: 3 additions & 0 deletions packages/whitepaper/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# README

The Taiko whitepaper. The automatically generated PDF file is hosted in this repository's GitHub Pages [link](https://taikochain.github.io/taiko-mono/taiko-whitepaper.pdf).
Binary file added packages/whitepaper/fig/TaikoEcosystemFin2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added packages/whitepaper/fig/discount_func.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added packages/whitepaper/fig/incentive_graph.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added packages/whitepaper/fig/lambda10.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added packages/whitepaper/fig/lambda20.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added packages/whitepaper/fig/relative_time_graph.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
938 changes: 938 additions & 0 deletions packages/whitepaper/main.tex

Large diffs are not rendered by default.

1 comment on commit 305df91

@vercel
Copy link

@vercel vercel bot commented on 305df91 Nov 10, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please sign in to comment.