Skip to content

Commit

Permalink
Direct readers to official doc website (#80)
Browse files Browse the repository at this point in the history
* Direct readers to official doc website

* Reorder sidebar
  • Loading branch information
roycclu authored Nov 29, 2024
1 parent bb64410 commit 6e972db
Show file tree
Hide file tree
Showing 5 changed files with 22 additions and 37 deletions.
24 changes: 5 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
# Website
# Visit the Official 0G Docs Website

This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.
If you want to learn more about 0G, visit the [0G Docs](https://docs.0g.ai/)

# Contributing to 0G Docs

### Installation

Expand All @@ -22,20 +24,4 @@ This command starts a local development server and opens up a browser window. Mo
$ yarn build
```

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

### Deployment

Using SSH:

```
$ USE_SSH=true yarn deploy
```

Not using SSH:

```
$ GIT_USER=<Your GitHub username> yarn deploy
```

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.
This command generates static content into the `build` directory and can be served using any static contents hosting service.
7 changes: 0 additions & 7 deletions docs/build-with-0g/compute-network/marketplace.md

This file was deleted.

2 changes: 1 addition & 1 deletion docs/build-with-0g/da-integration.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
id: da-integration
title: Setting Up DA Client Nodes
title: DA Client Nodes
sidebar_position: 2
---
import Tabs from '@theme/Tabs';
Expand Down
6 changes: 6 additions & 0 deletions docs/build-with-0g/marketplace.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
id: marketplace
title: Marketplace (coming soon)
---

Coming soon
20 changes: 10 additions & 10 deletions sidebars.ts
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,15 @@ const sidebars: SidebarsConfig = {
label: 'Build with 0G',
className: 'sidebar-category build-with-0g',
items: [
{
type: 'category',
label: 'Compute Network',
items: [
'build-with-0g/compute-network/overview',
'build-with-0g/compute-network/provider',
'build-with-0g/compute-network/sdk',
],
},
'build-with-0g/storage-sdk',
'build-with-0g/storage-cli',
'build-with-0g/da-integration',
Expand All @@ -62,18 +71,9 @@ const sidebars: SidebarsConfig = {
],
},
'build-with-0g/contracts',
'build-with-0g/marketplace',
'build-with-0g/faucet',
'build-with-0g/explorer',
{
type: 'category',
label: 'Compute Network',
items: [
'build-with-0g/compute-network/overview',
'build-with-0g/compute-network/provider',
'build-with-0g/compute-network/sdk',
'build-with-0g/compute-network/marketplace',
],
},
],
},
{
Expand Down

0 comments on commit 6e972db

Please sign in to comment.