Skip to content

Latest commit

 

History

History

README.md

TODO Index

This folder centralizes contributor queues and working spaces.

Contributor Queues

  • TODO_ANDREI.md
  • TODO_PETRICA.md
  • TODO_VITALII.md
  • TODO_ALESSANDRO.md
  • TODO_BASTIA.md
  • TODO_BLEO.md

Contributor Workspaces

  • andrei/
  • petrica/
  • vitalii/
  • alessandro/
  • bastia/
  • bleo/

Each contributor workspace includes:

  • plans/ for execution plans
  • prompts/ for reusable prompts
  • scraps/ for rough notes and temporary material

Ratio1 Documentation Structure

Moved from the old STRUCTURE.md. Instructions: everything after dash is a short description of the content to be included in that section/page and does not represent the actual title.

  1. Ratio1 Docs - welcome message (P)

  2. Ratio1 Overview - introduction to Ratio1 (AID) 2.1. [x] Decentralized Orchestration - orchestration review including Deeploy ChainDist CAR/WAR (AID) 2.2. [x] Distributed Storage - R1FS storage review (AID) 2.3. [x] Decentralized Apps - Distributed app state memory CStore (AID) 2.4. [x] The Plugins system - how plugins work on Ratio1 (AID)

  3. For Node Operators - introduction to node operation (P) 3.1. Getting Started with the main Dashboard - intro to the dashboard (P) 3.1.1. Buying your first Ratio1 license - purchasing and activating a license (P) 3.1.2. Linking your Edge Node - connecting your license with your nodes (P) 3.1.3. Rewards Understanding and Claiming- how rewards work on Ratio1 (P) 3.1.4. Selling or transferring your license - transferring ownership of your license (P) 3.2. Managing Edge Nodes with r1setup (V) 3.2.1. r1setup Overview - overview presentation with no details (V) 3.2.2. r1setup Quick Setup - a end-to-end multi-node express configuration (V) 3.2.3. r1setup Fleet Management - managing multiple nodes (V) 3.2.4. r1setup Migration Guide - migrating existing nodes configs (V) 3.2.5. r1setup Managing and Monitoring Nodes - monitoring node status and logs (V) 3.2.6. r1setup Hardening your fleet longins - security best practices via ssh keys (V) 3.2.7. r1setup Other Advanced Tools - advanced settings and options (V) 3.2.8. r1setup FAQ - frequently asked questions & troubleshooting (V) 3.3. Using Ratio1 Node Launcher (V) 3.3.1. Node Launcher Overview - overview presentation with no details (V) 3.3.2. Node Launcher Quick Setup - a end-to-end multi-node express configuration (V)

  4. For CSPs - introduction to CSP operation (P) 4.1. Getting Started with Ratio1 for CSPs - why and intro to the requirements (P) 4.1.1. Becoming a CSP - steps to become a CSP on Ratio1 (P) 4.1.1. Pricing and Business Model Intro - understanding costs and revenue (P) 4.2. Deepploying with Deeploy (P) 4.2.1. Deeploy Overview - overview presentation with no details (P) 4.2.2. Deeploy Quick Setup - a end-to-end setup with escroq and stuff (P) 4.2.3. Deeploy Managing Deployments - managing multiple deployments (P) 4.2.4. Deeploy End-to-End Example - complete example of a deployment (P)

  5. For Developers - introduction to developing on Ratio1 (AID) 5.1. [x] Python - using the Python SDK for Ratio1 (AID) 5.1.1. [x] Quick end-to-end example - a complete example of using the Python SDK (AID) 5.1.2. [x] Navigating the Tutorials - list of tutorials and explanations(AID) 5.1.3. [x] API Quick Reference - detailed API documentation (AID) 5.1.4. [x] The Edge Node Software - understanding the edge node software architecture (AID) 5.1.5. [x] Contributing to the Edge Node and Beyond - how to contribute to the project (AID) 5.2. JavaScript - using the JavaScript SDK for Ratio1 (Ale) 5.2.1. Quick end-to-end example - a complete example of using the JavaScript SDK (Ale) 5.2.2. API Quick Reference - detailed API documentation (Ale) 5.2.3. CStore Integration - using CStore with the JavaScript SDK (Ale) 5.2.4. R1FS Integration - using R1FS with the JavaScript SDK (Ale) 5.2.5. Simple auth - using SDK simple auth with the JavaScript SDK (Ale) 5.3. Go - using the Go SDK for Ratio1 (B) 5.3.1. Quick end-to-end example - a complete example of using the Go SDK (B) 5.3.2. API Quick Reference - detailed API documentation (B) 5.3.3. CStore Integration - using CStore with the Go SDK (B) 5.3.4. R1FS Integration - using R1FS with the Go SDK (B) 5.4. The Sandbox - using the Ratio1 Plugins Sandbox for testing and development (B) 5.4.1. Running the sandbox - start/install and CLI flags (B) 5.4.2. Seeding data - how to seed CStore and R1FS fixtures (B) 5.4.3. HTTP surface - endpoint list and what they do (B) 5.4.4. Using with SDKs - configure SDKs to target the sandbox (B) 5.4.5. Troubleshooting - common issues and debugging tips (B) 5.5. [x] r1ctl - the kubectl for Ratio1 (AID) 5.5.1. [x] r1ctl Overview - overview presentation with no details (AID) 5.5.2. [x] r1ctl Features (AID) 5.6. Donation add-on for developers (Ale)

  6. The Explorer - short introduction to the Ratio1 Explorer (P) 6.1. Nodes and Licenses - how to use the Explorer to view nodes and licenses (P) 6.2. Nodel Operators and CSPs - how to use the Explorer to view node operators and CSPs (P) 6.3. Stats and Analytics - how to use the Explorer to view stats and analytics (P)

  7. Other Tools - introduction to other Ratio1 tools (P) 7.1. Telegram Bot - using the Ratio1 Telegram Bot (Ale)

  8. Application Templates - introduction to Ratio1 application templates (AID) 8.1. R1FS Demo - js/ts demo application for R1FS (Ale) 8.1.1. How to Deeploy - deployment details of R1FS Demo (Ale) 8.1.2. How to Develop - technical details of R1FS Demo (Ale) 8.2. RedMesh Demo - js/ts demo application for RedMesh (V) 8.2.1. How to Deeploy - deployment details of RedMesh Demo (V) 8.2.2. How to Develop - technical details of RedMesh Demo (V) 8.3. Docs Template - the documentation site you are currently reading (P) 8.3.1. How to Deeploy - deployment details of Docs Template (P) 8.3.2. How to Develop - technical details of Docs Template (P)

  9. Deployable Services - introduction to deployable services on Ratio1 (V) 9.1. Service Catalog - catalog of services that can be deployed on Ratio1 (V) 9.2. Your Native App on Ratio1 - guide to deploying your native app on Ratio1 (V) 9.2.1. How to Deeploy - deployment details of Your Native App on Ratio1 (V) 9.2.2. How to Develop - technical details of Your Native App on Ratio1 (V)

  10. Partner Applications - Open Sourced template-ready partner applications built on Ratio1 (P) 10.1. CerviGuard - decentralized cervical cancer screening application (V) 10.1.1. How to Deeploy - deployment details of CerviGuard (V) 10.1.2. How to Develop - technical details of CerviGuard (V) 10.2. DataGen - decentralized synthetic data generation application (Bleo) 10.2.1. How to Deeploy - deployment details of DataGen (Bleo) 10.2.2. How to Develop - technical details of DataGen (Bleo) 10.3. ASPIRE - decentralized clinical management for various syndromes (P) 10.3.1. How to Deeploy - deployment details of ASPIRE (P) 10.3.2. How to Develop - technical details of ASPIRE (P)