From 8c308b8e83b9d4a8747c8155c5afa6e284fca995 Mon Sep 17 00:00:00 2001 From: Marco Argentieri <3596602+tiero@users.noreply.github.com> Date: Thu, 30 Nov 2023 19:52:23 +0100 Subject: [PATCH] remove site (#27) * remove src/pages for now * Ark as title --- .../blog/2023-11-10-liquidity-requirements.md | 2 +- website/docs/intro.md | 2 +- website/docs/intro/boarding.md | 10 ++-- website/docs/intro/payments.md | 12 ++-- website/docusaurus.config.js | 14 ++--- .../src/components/HomepageFeatures/index.js | 57 ------------------- .../HomepageFeatures/styles.module.css | 11 ---- website/src/css/custom.css | 30 ---------- website/src/pages/index.js | 45 --------------- website/src/pages/index.module.css | 23 -------- website/src/pages/markdown-page.md | 7 --- 11 files changed, 19 insertions(+), 194 deletions(-) delete mode 100644 website/src/components/HomepageFeatures/index.js delete mode 100644 website/src/components/HomepageFeatures/styles.module.css delete mode 100644 website/src/css/custom.css delete mode 100644 website/src/pages/index.js delete mode 100644 website/src/pages/index.module.css delete mode 100644 website/src/pages/markdown-page.md diff --git a/website/blog/2023-11-10-liquidity-requirements.md b/website/blog/2023-11-10-liquidity-requirements.md index 46569bd..2cf9b9b 100644 --- a/website/blog/2023-11-10-liquidity-requirements.md +++ b/website/blog/2023-11-10-liquidity-requirements.md @@ -18,7 +18,7 @@ All transactions within Ark must be funded by the Ark Service Provider (ASP) in This post discusses some considerations on this topic and calculates the funding needs of the ASP. -Refer to [nomenclature docs](/docs/nomenclature) for any doubt +Refer to [nomenclature docs](/nomenclature) for any doubt ## Ark liquidity requirements diff --git a/website/docs/intro.md b/website/docs/intro.md index 7d62fb3..cd38159 100644 --- a/website/docs/intro.md +++ b/website/docs/intro.md @@ -12,7 +12,7 @@ Bitcoin is the most secure and censorship blockchain in the world. However, it i ## 👷‍♂️ How does it work? - Start by reading the [Nomenclature](/docs/nomenclature.md) section to understand the key concepts and terminology used in Ark. Then, you can learn how to [Board the Ark](intro/boarding.md) and [Send Payments](intro/payments.md). Finally, you can learn how to [Leave the Ark](intro/leaving.md) and withdraw your funds back to the Bitcoin blockchain if the server is unresponsive. + Start by reading the [Nomenclature](/nomenclature.md) section to understand the key concepts and terminology used in Ark. Then, you can learn how to [Board the Ark](intro/boarding.md) and [Send Payments](intro/payments.md). Finally, you can learn how to [Leave the Ark](intro/leaving.md) and withdraw your funds back to the Bitcoin blockchain if the server is unresponsive. ## 👶🏼 ELI5 diff --git a/website/docs/intro/boarding.md b/website/docs/intro/boarding.md index cbc9a74..c0134f2 100644 --- a/website/docs/intro/boarding.md +++ b/website/docs/intro/boarding.md @@ -12,17 +12,17 @@ Alice wants to board the Ark of a well-known Ark service provider (ASP). It requ ### The timeline of events -1. Alice creates a [Funding transaction](/docs/nomenclature#funding-transaction) +1. Alice creates a [Funding transaction](/nomenclature#funding-transaction) -2. Alice adds any inputs she wants to cover the values the [VTXO](/docs/nomenclature#vtxo-1) she will receive, plus on-chain fees. +2. Alice adds any inputs she wants to cover the values the [VTXO](/nomenclature#vtxo-1) she will receive, plus on-chain fees. 3. Alice adds an output with **two spending conditions**: - `(ASP in 1 month)` - - A covenant output that forces coins to be spent by a [Redeem transaction](/docs/nomenclature#redeem-transaction) with an output with **two** spending conditions: + - A covenant output that forces coins to be spent by a [Redeem transaction](/nomenclature#redeem-transaction) with an output with **two** spending conditions: - `(Alice + ASP)` - `(Alice in 24 hours)` -4. Alice notifies ASP about the [Funding transaction](/docs/nomenclature#funding-transaction) +4. Alice notifies ASP about the [Funding transaction](/nomenclature#funding-transaction) -5. Alice has now a [VTXO](/docs/nomenclature#vtxo-1). +5. Alice has now a [VTXO](/nomenclature#vtxo-1). diff --git a/website/docs/intro/payments.md b/website/docs/intro/payments.md index 9857fe1..ebfb05e 100644 --- a/website/docs/intro/payments.md +++ b/website/docs/intro/payments.md @@ -14,12 +14,12 @@ Alice wants to send funds to Bob inside the Ark. ### Timeline of events -1. Alice tells ASP to send [VTXO](/docs/nomenclature#vtxo-1) to Bob -2. ASP (with Alice) prepares next [Pool transaction](/docs/nomenclature#pool-transaction-aka-ark-transaction) -3. Alice creates a [Forfeit transaction](/docs/nomenclature#forfeit-transaction): +1. Alice tells ASP to send [VTXO](/nomenclature#vtxo-1) to Bob +2. ASP (with Alice) prepares next [Pool transaction](/nomenclature#pool-transaction-aka-ark-transaction) +3. Alice creates a [Forfeit transaction](/nomenclature#forfeit-transaction): - spends from VTXO (1) via `Alice + ASP` - adds connector output from Pool transaction (2) as input - signs (SIGHASH_ALL) and sends it to the ASP -4. ASP broadcasts [Pool transaction](/docs/nomenclature#pool-transaction-aka-ark-transaction) -5. Bob has now a new [VTXO](/docs/nomenclature#vtxo-1) -6. For at most 4 weeks, Alice will be able to double spend her’s [VTXO](/docs/nomenclature#vtxo-1), but if she does it, the ASP will have time to grab the funds from the [VTXO](/docs/nomenclature#vtxo-1) to itself using the [Forfeit transaction](/docs/nomenclature#forfeit-transaction) +4. ASP broadcasts [Pool transaction](/nomenclature#pool-transaction-aka-ark-transaction) +5. Bob has now a new [VTXO](/nomenclature#vtxo-1) +6. For at most 4 weeks, Alice will be able to double spend her’s [VTXO](/nomenclature#vtxo-1), but if she does it, the ASP will have time to grab the funds from the [VTXO](/nomenclature#vtxo-1) to itself using the [Forfeit transaction](/nomenclature#forfeit-transaction) diff --git a/website/docusaurus.config.js b/website/docusaurus.config.js index ce7c444..21053b9 100644 --- a/website/docusaurus.config.js +++ b/website/docusaurus.config.js @@ -9,7 +9,7 @@ const config = { title: 'Ark', tagline: 'TBD', favicon: 'img/ark-logo.png', - url: 'https://dev.arkpill.me', + url: 'https://arkdev.info', baseUrl: '/', organizationName: 'Ark', projectName: 'Ark Website', @@ -26,6 +26,7 @@ const config = { /** @type {import('@docusaurus/preset-classic').Options} */ ({ docs: { + routeBasePath: "/", sidebarPath: require.resolve('./sidebars.js'), // Please change this to your repo. // Remove this to remove the "edit this page" links. @@ -37,9 +38,6 @@ const config = { // Remove this to remove the "edit this page" links. editUrl: 'https://github.com/ark-network/edit/master/website/blog/', }, - theme: { - customCss: require.resolve('./src/css/custom.css'), - }, }), ], ], @@ -50,7 +48,7 @@ const config = { // Replace with your project's social card image: 'img/ark-og-image.png', navbar: { - title: 'Developer Portal', + title: 'Ark', logo: { alt: 'Ark Logo', src: 'img/ark-logo.png', @@ -78,15 +76,15 @@ const config = { items: [ { label: 'What Ark is', - to: '/docs/specs/index', + to: '/specs/index', }, { label: 'Join the Ark', - to: '/docs/user/intro', + to: '/user/intro', }, { label: 'Create an Ark', - to: '/docs/provider/intro', + to: '/provider/intro', }, ], }, diff --git a/website/src/components/HomepageFeatures/index.js b/website/src/components/HomepageFeatures/index.js deleted file mode 100644 index 78026b4..0000000 --- a/website/src/components/HomepageFeatures/index.js +++ /dev/null @@ -1,57 +0,0 @@ -import React from 'react'; -import clsx from 'clsx'; -import styles from './styles.module.css'; - -const FeatureList = [ - { - title: 'Fast', - description: ( - <> - TBD. - - ), - }, - { - title: 'Secure', - description: ( - <> - TBD. - - ), - }, - { - title: 'Convenient', - description: ( - <> - TBD. - - ), - }, -]; - -function Feature({Svg, title, description}) { - return ( -
-
-
-
-

{title}

-

{description}

-
-
- ); -} - -export default function HomepageFeatures() { - return ( -
-
-
- {FeatureList.map((props, idx) => ( - - ))} -
-
-
- ); -} diff --git a/website/src/components/HomepageFeatures/styles.module.css b/website/src/components/HomepageFeatures/styles.module.css deleted file mode 100644 index b248eb2..0000000 --- a/website/src/components/HomepageFeatures/styles.module.css +++ /dev/null @@ -1,11 +0,0 @@ -.features { - display: flex; - align-items: center; - padding: 2rem 0; - width: 100%; -} - -.featureSvg { - height: 200px; - width: 200px; -} diff --git a/website/src/css/custom.css b/website/src/css/custom.css deleted file mode 100644 index 2bc6a4c..0000000 --- a/website/src/css/custom.css +++ /dev/null @@ -1,30 +0,0 @@ -/** - * Any CSS included here will be global. The classic template - * bundles Infima by default. Infima is a CSS framework designed to - * work well for content-centric websites. - */ - -/* You can override the default Infima variables here. */ -:root { - --ifm-color-primary: #2e8555; - --ifm-color-primary-dark: #29784c; - --ifm-color-primary-darker: #277148; - --ifm-color-primary-darkest: #205d3b; - --ifm-color-primary-light: #33925d; - --ifm-color-primary-lighter: #359962; - --ifm-color-primary-lightest: #3cad6e; - --ifm-code-font-size: 95%; - --docusaurus-highlighted-code-line-bg: rgba(0, 0, 0, 0.1); -} - -/* For readability concerns, you should choose a lighter palette in dark mode. */ -[data-theme='dark'] { - --ifm-color-primary: #25c2a0; - --ifm-color-primary-dark: #21af90; - --ifm-color-primary-darker: #1fa588; - --ifm-color-primary-darkest: #1a8870; - --ifm-color-primary-light: #29d5b0; - --ifm-color-primary-lighter: #32d8b4; - --ifm-color-primary-lightest: #4fddbf; - --docusaurus-highlighted-code-line-bg: rgba(0, 0, 0, 0.3); -} diff --git a/website/src/pages/index.js b/website/src/pages/index.js deleted file mode 100644 index 5a96131..0000000 --- a/website/src/pages/index.js +++ /dev/null @@ -1,45 +0,0 @@ -import React from 'react'; -import clsx from 'clsx'; -import Link from '@docusaurus/Link'; -import Translate from '@docusaurus/Translate' -import useDocusaurusContext from '@docusaurus/useDocusaurusContext'; -import Layout from '@theme/Layout'; -import HomepageFeatures from '@site/src/components/HomepageFeatures'; - -import styles from './index.module.css'; - -function HomepageHeader() { - const {siteConfig} = useDocusaurusContext(); - return ( -
-
-

{siteConfig.title}

-

{siteConfig.tagline}

-
- - DOCS - - - BLOG - -
-
-
- ); -} - -export default function Home() { - const {siteConfig} = useDocusaurusContext(); - return ( - - -
- -
- - ); -} diff --git a/website/src/pages/index.module.css b/website/src/pages/index.module.css deleted file mode 100644 index 9f71a5d..0000000 --- a/website/src/pages/index.module.css +++ /dev/null @@ -1,23 +0,0 @@ -/** - * CSS files with the .module.css suffix will be treated as CSS modules - * and scoped locally. - */ - -.heroBanner { - padding: 4rem 0; - text-align: center; - position: relative; - overflow: hidden; -} - -@media screen and (max-width: 996px) { - .heroBanner { - padding: 2rem; - } -} - -.buttons { - display: flex; - align-items: center; - justify-content: center; -} diff --git a/website/src/pages/markdown-page.md b/website/src/pages/markdown-page.md deleted file mode 100644 index 9756c5b..0000000 --- a/website/src/pages/markdown-page.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -title: Markdown page example ---- - -# Markdown page example - -You don't need React to write simple standalone pages.