Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added "getting started" page #162

Merged
merged 6 commits into from
Apr 24, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/api-intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,6 @@ id: api-intro

We designed Fula API to help you (a third-party, open-source developer) build other rich and compelling user experiences.

Want to get your hands dirty right away? Head over to [getting started](./getting-started).
Want to get your hands dirty right away? Head over to [getting started](api/getting-started).

If you're the kind of person who likes to read the entire manual before starting the engine, then visit the [Fula Reference API](./reference-api).
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: The Fula Client Library
id: fula-client
---
import WorkInProgress from '../components/WorkInProgress.mdx'
import WorkInProgress from '../../components/WorkInProgress.mdx'

# The Fula Client Library
Fula client lets you connect your web application to the Box using [libp2p](https://libp2p.io/). It helps DApp developers to use a Box as the back-end for their applications. You can use the File and Graph APIs to store and retrieve your data.
Expand Down
5 changes: 2 additions & 3 deletions docs/getting-started.md → docs/api/getting-started/index.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,10 @@
---
title: Getting Started
id: getting-started
id: index
---
# Getting Started

In order to start developing your own DApps on Fula, complete these two steps:

1. [Get the Box server up and running](/getting-started/box-setup).
1. [Get the Box server up and running](api/getting-started/box-setup).

2. Develop your own front-end, leveraging the Fula API.
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: Installing Box on Raspberry Pi OS
id: rpi-setup
---
import WorkInProgress from '../components/WorkInProgress.mdx'
import WorkInProgress from '../../components/WorkInProgress.mdx'

# Installing Box on Raspberry Pi OS

Expand Down
44 changes: 44 additions & 0 deletions docs/getting-started-testnet.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
---
title: Getting Started with FxBlox
id: getting-started-testnet
---
# Getting Started with FxBlox

Welcome to the world of FxBlox! This guide will walk you through the essentials to get your FxBlox device up and running smoothly.

## 1. Equipment Needed
To get started, you'll need the following equipment:
- A 25W PD2 compatible power adapter
- A USB thumb stick (4GB to 32GB) for initial setup
- An adapter from USB-C to USB-A (to connect the thumb stick to the blox)
- External storage device like SSDs, HDDs, and more
- For CM4 bloxes: external storage as mentioned above or [framework expansion cards](https://frame.work/marketplace/expansion-cards)
- For RK1 bloxes: internal m.2 nvme drive, external storage as mentioned above, or [framework expansion cards](https://frame.work/marketplace/expansion-cards)
- Optional: USB-C to ethernet adaptors and USB-C to HDMI for additional connectivity

Functionland does not get any kickback or royalties from the sale of Framework expansion cards. We recommend them because we designed the FxBlox case and modularity around their small form factor standard.

## 2. Identifying Your Blox
It is important you know which FxBlox you have before you move onto the setup stage! It will determine which route you follow, how you get support, and what software is compatible with your device. Checkout the [How To Identify Your FxBlox](/functionyard/hardware/fxblox-hardware) guide to learn more!

## 3. Reporting Issues
You can report issues through the following channels:
- Telegram: Join the [support channel](https://t.me/fxblox) for your Blox
- Discord: Submit tickets or chat in the [general chat group](https://discord.com/invite/7BunNHNWtz)
- GitHub:
- For FxBlox app issues: [Submit Here](https://github.com/functionland/fx-components/issues)
- For FxFotos app issues: [Submit Here](https://github.com/functionland/fx-fotos/issues)

## 4. High-Level Setup Process
At a high level, follow these steps to connect your Blox to the network:
1. Identify which Blox model you have (CM4 or RK1).
2. Follow the respective process to update your Blox.
3. Connect your Blox to Wi-Fi using the FxBlox app.
4. Join the testnet in both the FxBlox app and FxFotos app.
5. Start storing, earning, and uploading files to the network!

:::info
When going through the setup documentation, please read each instruction carefully! The docs are created to give you the smoothest onboarding experience as possible!
:::

Congratulations! You're now ready to explore the decentralized storage world with FxBlox. If you have any questions or need further assistance, don't hesitate to reach out through our support channels. Proceed to the [next page (Functionyard Testnet)](/functionyard) when you're ready!
15 changes: 10 additions & 5 deletions sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -42,9 +42,14 @@ const sidebars = {
}
]
},
{
type: 'doc',
label: 'Getting Started With FxBlox',
id: 'getting-started-testnet',
},
{
type: 'category',
label:'Functionyard Testnet',
label: 'Functionyard Testnet',
link: {
type:'doc',
id:'functionyard/index',
Expand Down Expand Up @@ -84,11 +89,11 @@ const sidebars = {
label:'Getting Started',
link: {
type:'doc',
id:'getting-started',
id:'api/getting-started/index',
},
items:[
'getting-started/box-setup',
'getting-started/using-samples',
'api/getting-started/box-setup',
'api/getting-started/using-samples',
]
},
{
Expand All @@ -99,7 +104,7 @@ const sidebars = {
id:'reference-api',
},
items:[
'api/client-instance',
'api/client-instance',
'api/graph-api',
'api/file-api'
]
Expand Down
Loading