From 99974199339a5d30cbcae1082f082c140399a853 Mon Sep 17 00:00:00 2001 From: mik-tf Date: Mon, 18 Nov 2024 02:16:18 -0500 Subject: [PATCH] updated docs --- docs_website/docs/legal/_category_.json | 2 +- docs_website/docs/marketplace/_category_.json | 2 +- docs_website/docs/nodes/_category_.json | 2 +- docs_website/docs/phones.md | 2 +- docs_website/docs/references/_category_.json | 2 +- docs_website/docs/references/manual.md | 2 +- .../system_components/_category_.json | 8 +++ .../system_components/hero_ai_assistant.md | 7 +++ .../system_components/mycelium_cdn.md | 7 +++ .../system_components/mycelium_chat.md | 7 +++ .../system_components/mycelium_message_bus.md | 7 +++ .../mycelium_naming_services.md | 7 +++ .../mycelium_quantum_safe_network.md | 11 ++++ .../system_components/mycelium_routers.md | 7 +++ .../mycelium_video_conferencing.md | 7 +++ .../system_components/mycelium_vpn.md | 9 ++++ .../mycelium_web2_gateway.md | 7 +++ .../mycelium_web3_gateway.md | 7 +++ .../mycelium_wifi_integration.md | 7 +++ .../quantum_safe_file_system.md | 13 +++++ .../system_components/threefold_connect.md | 7 +++ .../system_components/threefold_dashboard.md | 7 +++ .../threefold_decentralized_cloud.md | 7 +++ .../threefold_magic_cloud_node_cluster.md | 7 +++ .../threefold_marketplace.md | 7 +++ .../system_components/threefold_nodes.md | 7 +++ docs_website/docs/roadmap.md | 53 +++++++++++++++++++ docs_website/docs/routers.md | 2 +- docs_website/docusaurus.config.ts | 8 +++ 29 files changed, 221 insertions(+), 7 deletions(-) create mode 100644 docs_website/docs/references/system_components/_category_.json create mode 100644 docs_website/docs/references/system_components/hero_ai_assistant.md create mode 100644 docs_website/docs/references/system_components/mycelium_cdn.md create mode 100644 docs_website/docs/references/system_components/mycelium_chat.md create mode 100644 docs_website/docs/references/system_components/mycelium_message_bus.md create mode 100644 docs_website/docs/references/system_components/mycelium_naming_services.md create mode 100644 docs_website/docs/references/system_components/mycelium_quantum_safe_network.md create mode 100644 docs_website/docs/references/system_components/mycelium_routers.md create mode 100644 docs_website/docs/references/system_components/mycelium_video_conferencing.md create mode 100644 docs_website/docs/references/system_components/mycelium_vpn.md create mode 100644 docs_website/docs/references/system_components/mycelium_web2_gateway.md create mode 100644 docs_website/docs/references/system_components/mycelium_web3_gateway.md create mode 100644 docs_website/docs/references/system_components/mycelium_wifi_integration.md create mode 100644 docs_website/docs/references/system_components/quantum_safe_file_system.md create mode 100644 docs_website/docs/references/system_components/threefold_connect.md create mode 100644 docs_website/docs/references/system_components/threefold_dashboard.md create mode 100644 docs_website/docs/references/system_components/threefold_decentralized_cloud.md create mode 100644 docs_website/docs/references/system_components/threefold_magic_cloud_node_cluster.md create mode 100644 docs_website/docs/references/system_components/threefold_marketplace.md create mode 100644 docs_website/docs/references/system_components/threefold_nodes.md create mode 100644 docs_website/docs/roadmap.md diff --git a/docs_website/docs/legal/_category_.json b/docs_website/docs/legal/_category_.json index 42b445a..933b088 100644 --- a/docs_website/docs/legal/_category_.json +++ b/docs_website/docs/legal/_category_.json @@ -1,6 +1,6 @@ { "label": "Legal", - "position": 8, + "position": 9, "link": { "type": "generated-index", } diff --git a/docs_website/docs/marketplace/_category_.json b/docs_website/docs/marketplace/_category_.json index 801ced5..26294c1 100644 --- a/docs_website/docs/marketplace/_category_.json +++ b/docs_website/docs/marketplace/_category_.json @@ -1,6 +1,6 @@ { "label": "Marketplace", - "position": 6, + "position": 7, "link": { "type": "generated-index", "description": "Learn about the ThreeFold Marketplace, where you can offer and use cloud, data and network resources." diff --git a/docs_website/docs/nodes/_category_.json b/docs_website/docs/nodes/_category_.json index e1284d8..e01565f 100644 --- a/docs_website/docs/nodes/_category_.json +++ b/docs_website/docs/nodes/_category_.json @@ -1,6 +1,6 @@ { "label": "Nodes", - "position": 5, + "position": 4, "link": { "type": "generated-index", "description": "Learn about the ThreeFold nodes and how to earn rewards." diff --git a/docs_website/docs/phones.md b/docs_website/docs/phones.md index f0d402f..ede3c8d 100644 --- a/docs_website/docs/phones.md +++ b/docs_website/docs/phones.md @@ -1,5 +1,5 @@ --- -sidebar_position: 3 +sidebar_position: 5 --- # Phones diff --git a/docs_website/docs/references/_category_.json b/docs_website/docs/references/_category_.json index 5904b96..fbc6ff8 100644 --- a/docs_website/docs/references/_category_.json +++ b/docs_website/docs/references/_category_.json @@ -1,6 +1,6 @@ { "label": "References", - "position": 7, + "position": 8, "link": { "type": "generated-index" } diff --git a/docs_website/docs/references/manual.md b/docs_website/docs/references/manual.md index 868f352..894b573 100644 --- a/docs_website/docs/references/manual.md +++ b/docs_website/docs/references/manual.md @@ -6,4 +6,4 @@ sidebar_position: 6 The ThreeFold Docs website you are currently reading provides essential information on ThreeFold V4. -If you want to read advanced documentation concerning ThreeFold V3, you can visit the [***ThreeFold V3 Manual website***](https://manual.grid.tf/). This manual contains in-depth informations for ThreeFold Farmers, Sysadmins and Developers using the V3 iteration of the ThreeFold Grid. \ No newline at end of file +If you want to read advanced documentation concerning ThreeFold V3, you can visit the [***ThreeFold Cloud V3 Manual website***](https://manual.threefold.io/). This manual contains in-depth informations for ThreeFold Farmers, Sysadmins and Developers using ThreeFold Cloud V3. \ No newline at end of file diff --git a/docs_website/docs/references/system_components/_category_.json b/docs_website/docs/references/system_components/_category_.json new file mode 100644 index 0000000..e859735 --- /dev/null +++ b/docs_website/docs/references/system_components/_category_.json @@ -0,0 +1,8 @@ +{ + "label": "System Components", + "position": 4, + "link": { + "type": "generated-index", + "description": "All the components constituting the ThreeFold Web4 Project Mycelium self-healing data & cloud network." + } + } \ No newline at end of file diff --git a/docs_website/docs/references/system_components/hero_ai_assistant.md b/docs_website/docs/references/system_components/hero_ai_assistant.md new file mode 100644 index 0000000..585721d --- /dev/null +++ b/docs_website/docs/references/system_components/hero_ai_assistant.md @@ -0,0 +1,7 @@ +--- +sidebar_position: 20 +--- + +# Hero AI Assistant + +The Hero AI assistant component of the ThreeFold Platform is a private AI assistant that is there to help you in everyday task and enterprises, all the while being totally secure, encrypted and private. \ No newline at end of file diff --git a/docs_website/docs/references/system_components/mycelium_cdn.md b/docs_website/docs/references/system_components/mycelium_cdn.md new file mode 100644 index 0000000..97d9b6b --- /dev/null +++ b/docs_website/docs/references/system_components/mycelium_cdn.md @@ -0,0 +1,7 @@ +--- +sidebar_position: 17 +--- + +# Mycelium CDN + +The Mycelium CDN component of the ThreeFold Platform is a geographically distributed network of servers that deliver content to users based on their location. \ No newline at end of file diff --git a/docs_website/docs/references/system_components/mycelium_chat.md b/docs_website/docs/references/system_components/mycelium_chat.md new file mode 100644 index 0000000..c514ba3 --- /dev/null +++ b/docs_website/docs/references/system_components/mycelium_chat.md @@ -0,0 +1,7 @@ +--- +sidebar_position: 16 +--- + +# Mycelium Chat + +The Mycelium Chat component of the ThreeFold Platform is a peer-to-peer and end-to-end encrypted chat service. \ No newline at end of file diff --git a/docs_website/docs/references/system_components/mycelium_message_bus.md b/docs_website/docs/references/system_components/mycelium_message_bus.md new file mode 100644 index 0000000..a975ec1 --- /dev/null +++ b/docs_website/docs/references/system_components/mycelium_message_bus.md @@ -0,0 +1,7 @@ +--- +sidebar_position: 8 +--- + +# Mycelium Message Bus + +The Mycelium Message Bus component of the ThreeFold Platform is a software architecture pattern that acts as a central hub for communication between different parts of an application and between different applications. It facilitates asynchronous communication, enabling components to interact without direct coupling. \ No newline at end of file diff --git a/docs_website/docs/references/system_components/mycelium_naming_services.md b/docs_website/docs/references/system_components/mycelium_naming_services.md new file mode 100644 index 0000000..854ff47 --- /dev/null +++ b/docs_website/docs/references/system_components/mycelium_naming_services.md @@ -0,0 +1,7 @@ +--- +sidebar_position: 12 +--- + +# Mycelium Naming Services + +The Mycelium Naming Services component of the ThreeFold Platform is a crucial component in distributed systems and networks that provides a centralized way to map names to resources, allowing different parts of the system to find and access each other easily. It acts as a directory or phonebook, associating human-readable names (like "database server" or "web server") with actual network addresses or other identifiers (like IP addresses). \ No newline at end of file diff --git a/docs_website/docs/references/system_components/mycelium_quantum_safe_network.md b/docs_website/docs/references/system_components/mycelium_quantum_safe_network.md new file mode 100644 index 0000000..63c82c1 --- /dev/null +++ b/docs_website/docs/references/system_components/mycelium_quantum_safe_network.md @@ -0,0 +1,11 @@ +--- +sidebar_position: 6 +--- + +# Mycelium Quantum Safe Network + +The Mycelium Quantum Safe Network component of the ThreeFold platform is an overlay network which lives on top of the existing Internet or other peer-to-peer networks created. + +In the Mycelium network, everyone is connected to everyone. End-to-end encryption between users of an app and the app runs behind the network wall. Mycelium is an overlay network which lives on top of the existing Internet or other peer-to-peer networks created. In this network, everyone is connected to everyone. End-to-end encryption between users of an app and the app runs behind the network wall. + +Each user end network point is strongly authenticated and uniquely identified, independent of the network carrier used. There is no need for a centralized firewall or VPN solutions, as there is a circle-based networking security in place. \ No newline at end of file diff --git a/docs_website/docs/references/system_components/mycelium_routers.md b/docs_website/docs/references/system_components/mycelium_routers.md new file mode 100644 index 0000000..28cb8a8 --- /dev/null +++ b/docs_website/docs/references/system_components/mycelium_routers.md @@ -0,0 +1,7 @@ +--- +sidebar_position: 14 +--- + +# Mycelium Routers + +The Mycelium Router component of the ThreeFold Platform is a networking device that forwards data packets between computer networks using the Mycelium network. \ No newline at end of file diff --git a/docs_website/docs/references/system_components/mycelium_video_conferencing.md b/docs_website/docs/references/system_components/mycelium_video_conferencing.md new file mode 100644 index 0000000..2c3dd26 --- /dev/null +++ b/docs_website/docs/references/system_components/mycelium_video_conferencing.md @@ -0,0 +1,7 @@ +--- +sidebar_position: 15 +--- + +# Mycelium Video Conferencing + +The Mycelium Video Conferencing component of the ThreeFold Platform is a peer-to-peer and end-to-end encrypted video conferencing service. \ No newline at end of file diff --git a/docs_website/docs/references/system_components/mycelium_vpn.md b/docs_website/docs/references/system_components/mycelium_vpn.md new file mode 100644 index 0000000..d912dc9 --- /dev/null +++ b/docs_website/docs/references/system_components/mycelium_vpn.md @@ -0,0 +1,9 @@ +--- +sidebar_position: 18 +--- + +# Mycelium VPN + +The Mycelium VPN component of the ThreeFold Platform is a technology that creates a secure, encrypted connection between your device and a server on the internet. This "tunnel" allows you to access the internet as if you were physically located at the VPN server's location, effectively masking your actual IP address and location. + +What makes this VPN unique is that it uses the Mycelium network, which is end-to-end encrypted and resistant to quantum technologies. \ No newline at end of file diff --git a/docs_website/docs/references/system_components/mycelium_web2_gateway.md b/docs_website/docs/references/system_components/mycelium_web2_gateway.md new file mode 100644 index 0000000..de479d4 --- /dev/null +++ b/docs_website/docs/references/system_components/mycelium_web2_gateway.md @@ -0,0 +1,7 @@ +--- +sidebar_position: 7 +--- + +# Mycelium Web2 Gateway + +The Mycelium Web2 Gateway component of the ThreeFold Platform allows communication with Web2 apps. \ No newline at end of file diff --git a/docs_website/docs/references/system_components/mycelium_web3_gateway.md b/docs_website/docs/references/system_components/mycelium_web3_gateway.md new file mode 100644 index 0000000..f37f76a --- /dev/null +++ b/docs_website/docs/references/system_components/mycelium_web3_gateway.md @@ -0,0 +1,7 @@ +--- +sidebar_position: 19 +--- + +# Mycelium Web3 Gateway + +The Mycelium Web3 Gateway component of the ThreeFold Platform is a bridge that simplifies access to decentralized applications (dApps) and Web3 services for users who are not familiar with the technical complexities of Web3. It acts as a translator, bringing the user-friendly experience of Web2 to the decentralized world of Web3. \ No newline at end of file diff --git a/docs_website/docs/references/system_components/mycelium_wifi_integration.md b/docs_website/docs/references/system_components/mycelium_wifi_integration.md new file mode 100644 index 0000000..235a28c --- /dev/null +++ b/docs_website/docs/references/system_components/mycelium_wifi_integration.md @@ -0,0 +1,7 @@ +--- +sidebar_position: 13 +--- + +# Mycelium Wifi Integration + +The Mycelium Wifi Integration component of the ThreeFold Platform allows the Mycelium network to communicate over Wifi protocols. This is especially useful for the Mycelium router products. \ No newline at end of file diff --git a/docs_website/docs/references/system_components/quantum_safe_file_system.md b/docs_website/docs/references/system_components/quantum_safe_file_system.md new file mode 100644 index 0000000..9f29622 --- /dev/null +++ b/docs_website/docs/references/system_components/quantum_safe_file_system.md @@ -0,0 +1,13 @@ +--- +sidebar_position: 5 +--- + +# Quantum Safe File System + +The Quantum Safe File System component of the ThreeFold Platform is a redesigned storage system which can scale to a planetary level. It is super secure, private and fast enough for more use cases. It is designed to operate in a decentralized context and data can never be lost or corrupted. + +This storage system is: + +- A backend storage system +- It cannot be used by end users +- It's meant to be integrated with a front end storage system like e.g. S3 or a filesystem diff --git a/docs_website/docs/references/system_components/threefold_connect.md b/docs_website/docs/references/system_components/threefold_connect.md new file mode 100644 index 0000000..e92a9dc --- /dev/null +++ b/docs_website/docs/references/system_components/threefold_connect.md @@ -0,0 +1,7 @@ +--- +sidebar_position: 3 +--- + +# ThreeFold Connect + +The ThreeFold Connect component of the ThreeFold Platform is a mobile app that serves as a gateway to the ThreeFold ecosystem and its various ThreeFold products and services. \ No newline at end of file diff --git a/docs_website/docs/references/system_components/threefold_dashboard.md b/docs_website/docs/references/system_components/threefold_dashboard.md new file mode 100644 index 0000000..d1c98c1 --- /dev/null +++ b/docs_website/docs/references/system_components/threefold_dashboard.md @@ -0,0 +1,7 @@ +--- +sidebar_position: 2 +--- + +# ThreeFold Dashboard + +The ThreeFold Dashboard component of the ThreeFold Platform is the gateway to ThreeFold V3. With the Dashboard, you can deploy workloads on the grid, manage your node farms, vote on the DAO, and much more. \ No newline at end of file diff --git a/docs_website/docs/references/system_components/threefold_decentralized_cloud.md b/docs_website/docs/references/system_components/threefold_decentralized_cloud.md new file mode 100644 index 0000000..4aa7ff5 --- /dev/null +++ b/docs_website/docs/references/system_components/threefold_decentralized_cloud.md @@ -0,0 +1,7 @@ +--- +sidebar_position: 1 +--- + +# ThreeFold Decentralized Cloud + +The ThreeFold Decentralized Cloud component of the ThreeFold Platform can be seen as the culmination of all the ThreeFold technology up to the V3 grid release. \ No newline at end of file diff --git a/docs_website/docs/references/system_components/threefold_magic_cloud_node_cluster.md b/docs_website/docs/references/system_components/threefold_magic_cloud_node_cluster.md new file mode 100644 index 0000000..249e0f0 --- /dev/null +++ b/docs_website/docs/references/system_components/threefold_magic_cloud_node_cluster.md @@ -0,0 +1,7 @@ +--- +sidebar_position: 11 +--- + +# ThreeFold Magic Cloud Node Cluster + +The ThreeFold Magic Cloud Node Cluster component of the ThreeFold Platform is a software platform engineered for distributed edge clusters. It manages and orchestrates computing resources across multiple nodes, guaranteeing efficient data processing and high availability through its inherent redundancy. \ No newline at end of file diff --git a/docs_website/docs/references/system_components/threefold_marketplace.md b/docs_website/docs/references/system_components/threefold_marketplace.md new file mode 100644 index 0000000..2500c18 --- /dev/null +++ b/docs_website/docs/references/system_components/threefold_marketplace.md @@ -0,0 +1,7 @@ +--- +sidebar_position: 10 +--- + +# ThreeFold Marketplace + +The ThreeFold Marketplace component of the ThreeFold Platform is the online place to buy and sell cloud, data and network resources running on the ThreeFold Grid. \ No newline at end of file diff --git a/docs_website/docs/references/system_components/threefold_nodes.md b/docs_website/docs/references/system_components/threefold_nodes.md new file mode 100644 index 0000000..595a7e6 --- /dev/null +++ b/docs_website/docs/references/system_components/threefold_nodes.md @@ -0,0 +1,7 @@ +--- +sidebar_position: 4 +--- + +# ThreeFold Nodes + +The ThreeFold node component of the ThreeFold Platform is the backbone of the decentralized grid. A ThreeFold node is a modern computer running the Zero-OS self-healing operating system. Nodes connected together for the ThreeFold Grid. \ No newline at end of file diff --git a/docs_website/docs/roadmap.md b/docs_website/docs/roadmap.md new file mode 100644 index 0000000..873c440 --- /dev/null +++ b/docs_website/docs/roadmap.md @@ -0,0 +1,53 @@ +--- +sidebar_position: 3 +--- + +# Roadmap + +ThreeFold is building a self-healing data, network and cloud platform. This platform is a complete and cohesive system providing a viable and efficient alternative to current mainstream clouds. + +The whole is bigger than the sum of its parts with this project, as all components interact together to form a cohesive and complete data, network and cloud system. + +The following ThreeFold Roadmap presents the current state of the grid and what is to come. + +## Present and Future + +ThreeFold has accomplished so much over the years, and there is nothing stopping us. We are currently in the fourth phase of the grid, making significant progress towards building a viable alternative to mainstream cloud services. + +After more than a decade of work and creation, our vision hasn't changed: we are building a decentralized sovereign alternative to today's centralized Internet model. + +We are making significant progress towards realizing this vision. We present here the currently available features and the features that will be available in a near future. + +## Completed & Ongoing + +ThreeFold has built the foundation for a peer-to-peer cloud platform. Currently, the ThreeFold grid is in more than 50 countries with thousands of nodes online providing data, network and cloud resources to users. + +Anyone can become a farmer and contribute to the expansion of the grid. We've built planetary-scale quantum safe storage and network systems. Our technology has been in production for years and ThreeFold provides modern cloud features to users worldwide. + +Furthermore, ThreeFold is actively working on amazing features that will be sooner than later available on the ThreeFold platform. Many of those features are well on their way and we will update our community with news and updates. + +| Status | System Component | +|-----------|--------------| +| ✓ Completed | ThreeFold Decentralized Cloud | +| ✓ Completed | ThreeFold Dashboard | +| ✓ Completed | ThreeFold Connect | +| ✓ Completed | ThreeFold Nodes | +| ✓ Completed | Quantum Safe File System | +| ✓ Completed | Mycelium Quantum Safe Network | +| ✓ Completed | Mycelium Web2 Gateway | +| ✓ Completed | Mycelium Message Bus | +| 🔄 Ongoing | ThreeFold Marketplace | +| 🔄 Ongoing | ThreeFold Magic Cloud Node Cluster | +| 🔄 Ongoing | Mycelium Naming Services | +| 🔄 Ongoing | Mycelium Wifi Integration | +| 🔄 Ongoing | Mycelium Routers | +| 🔄 Ongoing | Mycelium Video Conferencing | +| 🔄 Ongoing | Mycelium Chat | +| 🔄 Ongoing | Mycelium CDN | +| 🔄 Ongoing | Mycelium VPN | +| 🔄 Ongoing | Mycelium Web3 Gateway | +| 🔄 Ongoing | Hero AI Assistant | + +## Component Details + +To learn more about each component, read the [System Components](./category/system-components) section. \ No newline at end of file diff --git a/docs_website/docs/routers.md b/docs_website/docs/routers.md index d7242c7..e17c432 100644 --- a/docs_website/docs/routers.md +++ b/docs_website/docs/routers.md @@ -1,5 +1,5 @@ --- -sidebar_position: 5 +sidebar_position: 6 --- # Routers diff --git a/docs_website/docusaurus.config.ts b/docs_website/docusaurus.config.ts index 47feddd..6b07d91 100644 --- a/docs_website/docusaurus.config.ts +++ b/docs_website/docusaurus.config.ts @@ -133,6 +133,10 @@ const config: Config = { label: 'Litepaper', to: '/docs/litepaper', }, + { + label: 'Roadmap', + to: '/docs/roadmap', + }, { label: 'References', to: '/docs/category/references', @@ -154,6 +158,10 @@ const config: Config = { label: 'Routers', to: '/docs/routers', }, + { + label: 'Marketplace', + to: '/docs/category/marketplace', + }, ], }, {