diff --git a/.github/workflows/preview.yml b/.github/workflows/preview.yml
index d1153aa7..16259fd8 100644
--- a/.github/workflows/preview.yml
+++ b/.github/workflows/preview.yml
@@ -24,6 +24,7 @@ jobs:
- uses: oven-sh/setup-bun@v2
# this has to match docusaurus's baseURL in docusaurus.config.js
- run: echo "GH_ACTION_DOCUSAURUS_BASE_URL=pr-preview/pr-${{ github.event.number }}" >> "$GITHUB_ENV"
+
- name: Install and Build
if: github.event.action != 'closed' # You might want to skip the build if the PR has been closed
run: |
@@ -31,6 +32,6 @@ jobs:
bun run build
- name: Deploy preview
- uses: rossjrw/pr-preview-action@v1
+ uses: rossjrw/pr-preview-action@v1.4.7
with:
source-dir: ./build
diff --git a/docs/archive/community/governance.todo b/docs/archive/community/governance.todo
index 6888dff3..d9081d64 100644
--- a/docs/archive/community/governance.todo
+++ b/docs/archive/community/governance.todo
@@ -29,7 +29,7 @@ In January of 2022, the community adopted a proposal to implement MVP community
-
+
@@ -50,5 +50,3 @@ While the working group process has been functional for coordination of tasks an
On 3 May 2022, the community voted to adopt the 0L Network Constitution, which lays out the Community’s foundational values. The creation of the Constitution was a major step towards establishing a decision framework and value system that can serve as the project’s north star as we move forward. You can [read the Constitution here.](http://openlibra.blog/community/governance/the-0l-network-constitution/)
-
-
diff --git a/docs/archive/proposals/October_2022_Governance_Recap.md b/docs/archive/proposals/October_2022_Governance_Recap.md
index 696951de..049894e5 100644
--- a/docs/archive/proposals/October_2022_Governance_Recap.md
+++ b/docs/archive/proposals/October_2022_Governance_Recap.md
@@ -1,3 +1,4 @@
+# October 2022 Governance Recap
The 0L Community recently concluded its first round of collaborative, decentralized strategic planning. Starting first with rounds of guided discussion on the [RadicalxChange Voice](https://voice.radicalxchange.org/) platform, the process culminated with a set of eight proposals for community vote. In this blog post, we’re going to take a brief look at the contents of those proposals and reflect on the outcomes of the vote.
@@ -219,5 +220,3 @@ Stepping back a moment and looking at the sum of the proposals on the slate:
At the end of all this, the answer to the question “where do we go from here?” depends on whether the individual members of our community can move forward with collaborative action. The successful completion of this community strategy development process, while meaningful, is all for naught if the community does not step up and commit the resources needed to operationalize the strategy.
-
-
diff --git a/docs/archive/proposals/Team_Arctika_Recommendation.md b/docs/archive/proposals/Team_Arctika_Recommendation.md
index b3bca3ba..9441d268 100644
--- a/docs/archive/proposals/Team_Arctika_Recommendation.md
+++ b/docs/archive/proposals/Team_Arctika_Recommendation.md
@@ -11,14 +11,17 @@ The crypto headwinds are significant: Regulatory pressure, fraud, scammers and a
## How much is necessary for the Infrastructure Escrow Fund (IEF)?
-We can estimate that, in order to attract validators, the network will have to pay each validator US$4-5k per month (this is consistent with what validators are paid in mature networks with smoothly operating software). In our interviews with professional validators, we arrived at $4,200 as our baseline. See the data in the table, below
-
+We can estimate that, in order to attract validators, the network will have to pay each validator US$4-5k per month (this is consistent with what validators are paid in mature networks with smoothly operating software). In our interviews with professional validators, we arrived at $4,200 as our baseline. See the data in the table, below:
+
+
+
The Team agrees that we need to provision for another 7 years of network operations. We’re roughly three years into the network’s life cycle at this point in time (1 year in testnet, followed by almost 2 years since Genesis). Altogether, we should make it through at least the first 10 years of the network.
Of course, translating a token with no market value into monthly USD amounts requires some assumptions about value. We must take a conservative approach on market cap, for "all weather conditions". Despite what we’ve seen with some of our peer networks, we can't reasonably say that the base case for networks is a valuation of $1B\+ over the next 7 years. Likewise a network worth less than $50M for many years likely leads to extinction. So, the calculations we made assumed a $100M market cap, from which a token value could be extrapolated; this seemed like a reasonable base-case (which could be substantiated further).
At that intersection: 100 validators earning $4,200 per month over 7 years, with a network on average worth $100m, the result is approx 35% of network capital needs to be pre-diluted for sufficient safety.
-
+
+
### Over-allocation
@@ -75,7 +78,8 @@ We looked at many models of dilutions and fees. Asking validators to invest 80%
* Reduce the gap between worker and validators to 1\.3X from 16X.
-
+
+
We think this allocation, with abundant amounts for future capital, which honors prior workers such that we can continue recruiting for future talent, and sets up all current participants for future success is **unique and exemplary in the industry, and fulfills our mission of creating "good capital" and gives us the best shot at surviving and thriving.**
diff --git a/docs/assets/infrastructure-escrow-pledge-sensitivity.png b/docs/assets/infrastructure-escrow-pledge-sensitivity.png
new file mode 100644
index 00000000..86c6d035
Binary files /dev/null and b/docs/assets/infrastructure-escrow-pledge-sensitivity.png differ
diff --git a/docs/assets/summary-dilution-impacts.png b/docs/assets/summary-dilution-impacts.png
new file mode 100644
index 00000000..c24cdaa9
Binary files /dev/null and b/docs/assets/summary-dilution-impacts.png differ
diff --git a/docs/assets/validator-opportunity-cost.png b/docs/assets/validator-opportunity-cost.png
new file mode 100644
index 00000000..008f41bf
Binary files /dev/null and b/docs/assets/validator-opportunity-cost.png differ
diff --git a/docs/assets/wg-org-chart-example.png b/docs/assets/wg-org-chart-example.png
new file mode 100644
index 00000000..97d9c84b
Binary files /dev/null and b/docs/assets/wg-org-chart-example.png differ
diff --git a/docs/community programs/_category_.json b/docs/community programs/_category_.json
new file mode 100644
index 00000000..4107173d
--- /dev/null
+++ b/docs/community programs/_category_.json
@@ -0,0 +1,8 @@
+{
+ "label": "Programs",
+ "position": 3,
+ "link": {
+ "type": "generated-index",
+ "description": "Third-party programs by community members"
+ }
+}
diff --git a/docs/developers/_category_.json b/docs/developers/_category_.json
index e4b159d7..7b133531 100644
--- a/docs/developers/_category_.json
+++ b/docs/developers/_category_.json
@@ -1,6 +1,6 @@
{
"label": "Developers",
- "position": 6,
+ "position": 4,
"link": {
"type": "generated-index",
"description": "Information for Developing of the 0L Network"
diff --git a/docs/edit-docs/_category_.json b/docs/edit-docs/_category_.json
new file mode 100644
index 00000000..faa761d4
--- /dev/null
+++ b/docs/edit-docs/_category_.json
@@ -0,0 +1,8 @@
+{
+ "label": "Write Docs",
+ "position": 10,
+ "link": {
+ "type": "generated-index",
+ "description": "Tooling information for the 0L Network"
+ }
+}
diff --git a/docs/edit-docs/editing.md b/docs/edit-docs/editing.md
new file mode 100644
index 00000000..44bff60d
--- /dev/null
+++ b/docs/edit-docs/editing.md
@@ -0,0 +1,82 @@
+---
+# BAD: you should not include a `title` field here, instead you should carefully consider the actual header in the document. Notice in this example it is different than the filename.
+
+# title: "Quick Start"
+
+# GOOD: if I want a different label in the menu rather than my title (e.g. because it's too long)
+# sidebar_label: 'My Title'
+
+# GOOD: if I want to propose an order to the menu
+# sidebar_position: 5
+
+# GOOD: shall we hide this page in the menu?
+# hidden: true
+
+# BAD: if you add a description you'll need to maintain it. Better to not use it.
+# description: 'Shows this on mouseover'
+---
+
+# Editing Documents
+
+## Conventions
+
+### Filenames
+filenames are in "snakecase", lowercase, with underscore for spaces. The file extension should always be `.md`.
+
+Like this:
+ `this_is_a_file.md`
+
+### Metadata
+At the top of an `.md` file you may include some metadata which Docusaurus will be able to read and use for parts of the UX (e.g. titles, is it hidden, menu position).
+
+```
+---
+title: "Menu Title"
+sidebar_label: 'My Title'
+sidebar_position: 5
+hidden: true
+description: 'Shows this on mouseover'
+---
+```
+### Titles
+There are two ways to set the title in docusaurus. Either set it in the metadata, or put a top level section header `# This Title`.
+You should always have a document that begins with a section title.
+
+##### Don't use metadata
+You should not include a `title` field in metadata, instead you should carefully consider the actual header in the document.
+
+### Menu Labels
+The fallback behavior for menu link names will be the filename, e.g.: `this_is_a_file`.
+However if your Doc begins with a header title, e.g.: `# My Article`, then the menu label will be exactly that.
+To override both cases you can include this item to the metadata: `sidebar_label: Actual Label`.
+
+#### Images
+Do not link externally to images. Place copies of images in the `./docs/assets` folder.
+
+Then you can link with:
+```
+ `
+```
+Note: image names need to follow the same convention.
+
+## Submit edits
+
+### A Casual Edit
+
+Make the change using GitHub directly. You'll need a GitHub account for this. A pull request will be created.
+
+### Heavy Users
+You'll need to fork this `documentation` repo into your own GitHub account.
+
+#### Get your own repo set up
+Create a fork of this repository on your own account, it will look like this: `my-account/documentation`.
+
+#### Branch
+Make a new branch for each major change you are going to make. You'll always branch from your `main`.
+
+Important: don't make your edits on the `main` branch of your fork. You'll want to keep that one clean, so you can sync from this canonical repo (there's a helpful button on the GitHub interface to do this for you).
+
+At the end of this you'll have a branch named for example: `some-new-edits`, that lives on `my-account/documentation`.
+
+##### Submit
+Then send that branch as a pull request back to the community's repo. I.e.: the `some-edits` branch of `my-account/documentation`, will then be proposed as a change to `main` of `0LNetworkCommunity/documentation`.
diff --git a/docs/misc/_category_.json b/docs/misc/_category_.json
index 0049349c..9c036af7 100644
--- a/docs/misc/_category_.json
+++ b/docs/misc/_category_.json
@@ -1,8 +1,8 @@
{
- "label": "Misc",
- "position": 10,
+ "label": "Transactions",
+ "position": 2,
"link": {
"type": "generated-index",
- "description": "Unsorted docs"
+ "description": "Helpful instructions for submitting transactions"
}
}
diff --git a/docs/tutorial-basics/_category_.json b/docs/tutorial-basics/_category_.json
deleted file mode 100644
index c73e4493..00000000
--- a/docs/tutorial-basics/_category_.json
+++ /dev/null
@@ -1,8 +0,0 @@
-{
- "label": "Contribute to Docs",
- "position": 11,
- "link": {
- "type": "generated-index",
- "description": "5 minutes to learn the most important Docusaurus concepts."
- }
-}
diff --git a/docs/tutorial-basics/create-a-document.md b/docs/tutorial-basics/create-a-document.md
deleted file mode 100644
index ffddfa8e..00000000
--- a/docs/tutorial-basics/create-a-document.md
+++ /dev/null
@@ -1,57 +0,0 @@
----
-sidebar_position: 2
----
-
-# Create a Document
-
-Documents are **groups of pages** connected through:
-
-- a **sidebar**
-- **previous/next navigation**
-- **versioning**
-
-## Create your first Doc
-
-Create a Markdown file at `docs/hello.md`:
-
-```md title="docs/hello.md"
-# Hello
-
-This is my **first Docusaurus document**!
-```
-
-A new document is now available at [http://localhost:3000/docs/hello](http://localhost:3000/docs/hello).
-
-## Configure the Sidebar
-
-Docusaurus automatically **creates a sidebar** from the `docs` folder.
-
-Add metadata to customize the sidebar label and position:
-
-```md title="docs/hello.md" {1-4}
----
-sidebar_label: 'Hi!'
-sidebar_position: 3
----
-
-# Hello
-
-This is my **first Docusaurus document**!
-```
-
-It is also possible to create your sidebar explicitly in `sidebars.js`:
-
-```js title="sidebars.js"
-module.exports = {
- tutorialSidebar: [
- 'intro',
- // highlight-next-line
- 'hello',
- {
- type: 'category',
- label: 'Tutorial',
- items: ['tutorial-basics/create-a-document'],
- },
- ],
-};
-```
diff --git a/docs/tutorial-basics/img/docsVersionDropdown.png b/docs/tutorial-basics/img/docsVersionDropdown.png
deleted file mode 100644
index 97e41646..00000000
Binary files a/docs/tutorial-basics/img/docsVersionDropdown.png and /dev/null differ
diff --git a/docs/tutorial-basics/img/localeDropdown.png b/docs/tutorial-basics/img/localeDropdown.png
deleted file mode 100644
index e257edc1..00000000
Binary files a/docs/tutorial-basics/img/localeDropdown.png and /dev/null differ
diff --git a/docs/tutorial-basics/intro.md b/docs/tutorial-basics/intro.md
deleted file mode 100644
index 216220c0..00000000
--- a/docs/tutorial-basics/intro.md
+++ /dev/null
@@ -1,30 +0,0 @@
----
-sidebar_position: 1
----
-
-# Documentation tutorial
-
-- 0L Network Documentation repo is based on [Docusaurus](https://docusaurus.io/) tool.
-
-- You can **play around with Docusaurus online** at **[docusaurus.new](https://docusaurus.new)**.
-
-## Run this repo locally
-
-- As a requirement to run Docusaurus locally, you need [Node.js](https://nodejs.org/en/download/) version 16.14 or above installed on your machine.
- - When installing Node.js, you are recommended to check all checkboxes related to dependencies.
-- Fork the current repository and clone it.
-- Create a new branch with `git branch new_branch_name`
-
-```bash
-# Go to the repository directory in your local machine
-cd documentation
-# Run the Docusaurus locally
-npm run start
-```
-
-The `npm run start` command builds your website locally and serves it through a development server, ready for you to view at http://localhost:3000/.
-
-## Submit your changes
-
-- Commit your changes locally, and push them to your forked repository.
-- Go to your GitHub.com repository page and create a pull request to the up-stream repo.
diff --git a/docs/tutorial-basics/markdown-features.mdx b/docs/tutorial-basics/markdown-features.mdx
deleted file mode 100644
index 2f1b88b7..00000000
--- a/docs/tutorial-basics/markdown-features.mdx
+++ /dev/null
@@ -1,150 +0,0 @@
----
-sidebar_position: 3
----
-
-# Markdown Features
-
-Docusaurus supports **[Markdown](https://daringfireball.net/projects/markdown/syntax)** and a few **additional features**.
-
-## Front Matter
-
-Markdown documents have metadata at the top called [Front Matter](https://jekyllrb.com/docs/front-matter/):
-
-```text title="my-doc.md"
-// highlight-start
----
-id: my-doc-id
-title: My document title
-description: My document description
-slug: /my-custom-url
----
-// highlight-end
-
-## Markdown heading
-
-Markdown text with [links](./hello.md)
-```
-
-## Links
-
-Regular Markdown links are supported, using url paths or relative file paths.
-
-```md
-Let's see how to [Create a document](/create-a-document).
-```
-
-```md
-Let's see how to [Create a document](./create-a-document.md).
-```
-
-**Result:** Let's see how to [Create a document](./create-a-document.md).
-
-## Images
-
-Regular Markdown images are supported.
-
-You can use absolute paths to reference images in the static directory (`static/img/0LNetwork.png`):
-
-```md
-
-```
-
-
-
-You can reference images relative to the current file as well. This is particularly useful to colocate images close to the Markdown files using them:
-
-```md
-
-```
-
-## Code Blocks
-
-Markdown code blocks are supported with Syntax highlighting.
-
- ```jsx title="src/components/HelloDocusaurus.js"
- function HelloDocusaurus() {
- return (
- Hello, Docusaurus!
- )
- }
- ```
-
-```jsx title="src/components/HelloDocusaurus.js"
-function HelloDocusaurus() {
- return Hello, Docusaurus!
;
-}
-```
-
-## Admonitions
-
-Docusaurus has a special syntax to create admonitions and callouts:
-
- :::tip My tip
-
- Use this awesome feature option
-
- :::
-
- :::danger Take care
-
- This action is dangerous
-
- :::
-
-:::tip My tip
-
-Use this awesome feature option
-
-:::
-
-:::danger Take care
-
-This action is dangerous
-
-:::
-
-## MDX and React Components
-
-[MDX](https://mdxjs.com/) can make your documentation more **interactive** and allows using any **React components inside Markdown**:
-
-```jsx
-export const Highlight = ({children, color}) => (
- {
- alert(`You clicked the color ${color} with label ${children}`)
- }}>
- {children}
-
-);
-
-This is Docusaurus green !
-
-This is Facebook blue !
-```
-
-export const Highlight = ({children, color}) => (
- {
- alert(`You clicked the color ${color} with label ${children}`);
- }}>
- {children}
-
-);
-
-This is Docusaurus green !
-
-This is Facebook blue !
diff --git a/docs/tutorial-basics/translate-your-site.md b/docs/tutorial-basics/translate-your-site.md
deleted file mode 100644
index f4c94511..00000000
--- a/docs/tutorial-basics/translate-your-site.md
+++ /dev/null
@@ -1,88 +0,0 @@
----
-sidebar_position: 4
----
-
-# Translate your site
-
-Let's translate `docs/intro.md` to French.
-
-## Configure i18n
-
-Modify `docusaurus.config.js` to add support for the `fr` locale:
-
-```js title="docusaurus.config.js"
-module.exports = {
- i18n: {
- defaultLocale: 'en',
- locales: ['en', 'fr'],
- },
-};
-```
-
-## Translate a doc
-
-Copy the `docs/intro.md` file to the `i18n/fr` folder:
-
-```bash
-mkdir -p i18n/fr/docusaurus-plugin-content-docs/current/
-
-cp docs/intro.md i18n/fr/docusaurus-plugin-content-docs/current/intro.md
-```
-
-Translate `i18n/fr/docusaurus-plugin-content-docs/current/intro.md` in French.
-
-## Start your localized site
-
-Start your site on the French locale:
-
-```bash
-npm run start -- --locale fr
-```
-
-Your localized site is accessible at [http://localhost:3000/fr/](http://localhost:3000/fr/) and the `Getting Started` page is translated.
-
-:::caution
-
-In development, you can only use one locale at a same time.
-
-:::
-
-## Add a Locale Dropdown
-
-To navigate seamlessly across languages, add a locale dropdown.
-
-Modify the `docusaurus.config.js` file:
-
-```js title="docusaurus.config.js"
-module.exports = {
- themeConfig: {
- navbar: {
- items: [
- // highlight-start
- {
- type: 'localeDropdown',
- },
- // highlight-end
- ],
- },
- },
-};
-```
-
-The locale dropdown now appears in your navbar:
-
-
-
-## Build your localized site
-
-Build your site for a specific locale:
-
-```bash
-npm run build -- --locale fr
-```
-
-Or build your site to include all the locales at once:
-
-```bash
-npm run build
-```