From 09fbcb24af69bea7e1d380a8bb0211e3d9f94e20 Mon Sep 17 00:00:00 2001 From: Evgheni Poleacov Date: Wed, 9 Jul 2025 18:03:30 +0300 Subject: [PATCH] added intro, GNFT and CNFT overview pages --- docs/intro.md | 48 -------------------------- docs/overview/_category_.json | 5 +++ docs/overview/intro.md | 59 +++++++++++++++++++++++++++++++ docs/overview/nft-config.md | 65 +++++++++++++++++++++++++++++++++++ docs/overview/nft-gas.md | 59 +++++++++++++++++++++++++++++++ 5 files changed, 188 insertions(+), 48 deletions(-) delete mode 100644 docs/intro.md create mode 100644 docs/overview/_category_.json create mode 100644 docs/overview/intro.md create mode 100644 docs/overview/nft-config.md create mode 100644 docs/overview/nft-gas.md diff --git a/docs/intro.md b/docs/intro.md deleted file mode 100644 index 63c8de0..0000000 --- a/docs/intro.md +++ /dev/null @@ -1,48 +0,0 @@ ---- -sidebar_position: 1 -slug: / ---- - -# Introduction - -Let's discover **Docusaurus in less than 5 minutes**. - -## Getting Started - -Get started by **creating a new site**. - -Or **try Docusaurus immediately** with **[docusaurus.new](https://docusaurus.new)**. - -### What you'll need - -- [Node.js](https://nodejs.org/en/download/) version 18.0 or above: - - When installing Node.js, you are recommended to check all checkboxes related to dependencies. - -## Generate a new site - -Generate a new Docusaurus site using the **classic template**. - -The classic template will automatically be added to your project after you run the command: - -```bash -npm init docusaurus@latest my-website classic -``` - -You can type this command into Command Prompt, Powershell, Terminal, or any other integrated terminal of your code editor. - -The command also installs all necessary dependencies you need to run Docusaurus. - -## Start your site - -Run the development server: - -```bash -cd my-website -npm run start -``` - -The `cd` command changes the directory you're working with. In order to work with your newly created Docusaurus site, you'll need to navigate the terminal there. - -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/. - -Open `docs/intro.md` (this page) and edit some lines: the site **reloads automatically** and displays your changes. diff --git a/docs/overview/_category_.json b/docs/overview/_category_.json new file mode 100644 index 0000000..ac38177 --- /dev/null +++ b/docs/overview/_category_.json @@ -0,0 +1,5 @@ +{ + "label": "Overview", + "position": 1, + "collapsed": false +} diff --git a/docs/overview/intro.md b/docs/overview/intro.md new file mode 100644 index 0000000..2b9905c --- /dev/null +++ b/docs/overview/intro.md @@ -0,0 +1,59 @@ +--- +id: intro +slug: / +title: Welcome to Overlock Network +sidebar_position: 0 +sidebar_label: 'Introduction' +--- + +# 🌐 Welcome to Overlock Network + +**Overlock Network** is a decentralized system for managing external infrastructure through distributed execution. +It is built with the [**Cosmos SDK**](https://cosmos.network/appchains/) and extends the control plane model using [**Crossplane**](https://crossplane.io) . + +In Overlock Network, Active Resources are on-chain definitions that tell provider-hosted controllers how to create and manage infrastructure in cloud and edge environments. +As a result, Overlock Network can coordinate infrastructure on platforms such as GCP, AWS, Azure, Akash, DigitalOcean, and others. + +--- + +## 🧱 Core Concepts + +The network is centered around a small number of composable, on-chain objects: + +- **Active Resources** + Describe the infrastructure or services to be created and managed externally. + +- [**Configuration NFTs**](./overview/nft-config) + Represent access to reusable infrastructure definitions (similar to a configuration library). + +- [**Gas NFTs**](./overview/nft-gas) + Store a balance of execution tokens, which are gradually consumed as infrastructure operations are performed. + +--- + + +## 🌍 Distributed Providers + +Overlock does not run infrastructure itself. +Instead, it relies on an open set of **independent providers** who run trusted execution environments and Crossplane-based controllers. +These providers process on-chain requests, access cloud APIs, and consume gas as work is completed. + +Each interaction is tied to ownership: +- users retain control through NFTs and token balances +- providers receive compensation through gas consumption + +--- + +## 🧩 Modularity and Extensibility + +Overlock is designed to support many use cases: +- cloud automation +- edge orchestration +- multi-provider workflows +- agent-based infrastructure management + +Its primitives β€” Active Resources, Configuration NFTs, and Gas NFTs β€” can be extended or composed to support increasingly complex systems and tooling. + +--- + +Overlock Network provides a programmable and verifiable way to control external infrastructure β€” with ownership and automation at its core. \ No newline at end of file diff --git a/docs/overview/nft-config.md b/docs/overview/nft-config.md new file mode 100644 index 0000000..459647a --- /dev/null +++ b/docs/overview/nft-config.md @@ -0,0 +1,65 @@ +--- +id: nft-config +title: Configuration NFTs +sidebar_position: 1 +label: 'Overview' + +--- + +Configuration NFTs represent ownership of a resource library β€” a packaged set of instructions and definitions used to create Active Resources within the network. + +These NFTs do not activate resources directly. Instead, they grant the user the right to use a specific configuration when creating new resources. + +--- + +## 🎯 What They Represent + +Each Configuration NFT corresponds to a resource library. +This library defines how a particular type of infrastructure or service is created, including parameters, components, and system behavior. + +Owning the NFT means the user is allowed to use that configuration across the network. + +--- + +## βš™οΈ How It Works + +When a user obtains a Configuration NFT, it is stored in their wallet. +Later, when they create a new Active Resource through the Console or API, the system automatically checks if they own the required NFT. + +If they do, the configuration is installed during resource creation. +This process is seamless β€” the resource provider doesn't need to manage configurations manually. + +--- + +## 🧩 Why It’s Needed + +Configuration NFTs make it possible to: + +- Distribute infrastructure templates across the network +- Prove configuration ownership on-chain +- Allow providers to install and apply user-selected logic securely +- Ensure only authorized users can trigger configuration-based resource creation + +--- + +## πŸ”„ Transfer and Reuse + +Configuration NFTs are transferable. A user can pass or sell the NFT to another wallet, which then gains the right to use that configuration. + +The same configuration can be used by many users β€” each with their own copy of the NFT. + +--- + +## πŸ“Œ Features + +- Can include versioning, expiration, or policy metadata +- May be bundled with Gas NFTs or other entitlements +- Enable modular, reusable, and decentralized infrastructure logic + +--- + +## βœ… Summary + +Configuration NFTs are the key to owning and using resource creation logic in the network. +They do not execute or control anything directly β€” but without them, resources cannot be created. +They let the Console and providers know: *β€œthis user has the right to use this library.”* diff --git a/docs/overview/nft-gas.md b/docs/overview/nft-gas.md new file mode 100644 index 0000000..b159408 --- /dev/null +++ b/docs/overview/nft-gas.md @@ -0,0 +1,59 @@ +--- +id: nft-gas +title: Gas NFTs +sidebar_position: 2 +--- + +Gas NFTs (Execution Credit Containers) are digital containers that store execution credit. +They allow you to run and maintain Active Resources in the network by holding a prepaid balance of resource tokens. + +These tokens are securely stored on a dedicated account linked to the NFT. +You don’t need to manage this account directly β€” the system handles everything automatically during usage. + +--- + +## 🎯 What a Gas NFT Does + +If you hold a Gas NFT, it means you have fuel to power your infrastructure. + +Whenever you create or use an Active Resource, the system checks the available credit and deducts what’s needed from the linked account. + +--- + +## πŸ” Using and Reusing + +You can use a Gas NFT until its credit is fully spent. +You can also transfer it to someone else β€” they’ll get access to the remaining gas. + +There’s no need to refill or adjust anything manually. If you need more gas, simply get another NFT or receive one from someone else. + +--- + +## πŸ”„ Flexible and Transferable + +Gas NFTs are easy to trade, gift, or bundle with other types of NFTs. +For example, you might receive a configuration and gas together as part of a setup pack. + +As long as the NFT still holds credit, it can be used by whoever owns it. + +--- + +## πŸ’‘ Types of Gas NFTs + +Some Gas NFTs might include additional features: + +- **Nitro Packs** for high-performance access +- **Promo Drops** with bonus fuel +- **Timed Fuel** that expires if not used by a certain date + +These variations let users choose the right kind of gas for their needs. + +--- + +## βœ… Summary + +A Gas NFT is your prepaid fuel card for the network. +It connects to a special account that holds your resource credit, which is used automatically as you create and run Active Resources. + +You stay in control β€” just hold it, use it, or pass it on. +When it’s empty, get a new one and keep going.