Skip to content

Commit 61ad4c2

Browse files
gagdiezmatiasbenaryGuillermo Alejandro Gallardo Diez
authored
Fix llms descriptions (#2632)
* feat: add script to generate and include llms.txt in build * chore: minor changes * chore: make sure docs start with description * chore: fix descriptions * feat: add description to docs * Apply suggestions from code review --------- Co-authored-by: Matias Benary <matiasbenary@gmail.com> Co-authored-by: Guillermo Alejandro Gallardo Diez <gagdiez@MacBookPro.home>
1 parent d222f59 commit 61ad4c2

File tree

88 files changed

+181
-150
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

88 files changed

+181
-150
lines changed

docs/ai/shade-agents/examples.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,6 @@ title: What can you Build?
44
sidebar_label: What can you Build?
55
---
66

7-
# What can you build with Shade Agents?
8-
97
With their extensive list of features, Shade Agents unlock a wide range of new use cases, enable many previously centralized apps to become decentralized, and change how blockchain applications are designed.
108

119
## Shade Agent Features

docs/ai/shade-agents/production/deploying.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,6 @@ sidebar_label: Deploying an Agent
66

77
import { SigsSupport } from '@site/src/components/sigsSupport';
88

9-
# Deploying an Agent
10-
119
In this section we'll walk through deploying your first Shade Agent. The template we're using is a simple Shade Agent built with NextJS that acts as a verifiable ETH price oracle. It takes prices from two different APIs, takes the average and then pushes the price to an Ethereum contract.
1210

1311
We'll cover two deployment scenarios:

docs/chain-abstraction/meta-tx.md

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,7 @@ title: Meta Transactions
44
sidebar_label: NEP-366
55
---
66

7-
[NEP-366](https://github.com/near/NEPs/pull/366) introduced the concept of meta
8-
transactions to Near Protocol. This feature allows users to execute transactions
9-
on NEAR without owning any gas or tokens. In order to enable this, users
10-
construct and sign transactions off-chain. A third party (the relayer) is used
11-
to cover the fees of submitting and executing the transaction.
7+
[NEP-366](https://github.com/near/NEPs/pull/366) introduced the concept of meta transactions to Near Protocol. This feature allows users to execute transactions on NEAR without owning any gas or tokens. In order to enable this, users construct and sign transactions off-chain. A third party (the relayer) is used to cover the fees of submitting and executing the transaction.
128

139
---
1410

docs/chain-abstraction/omnibridge/how-it-works.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,6 @@ sidebar_label: How It Works
44
title: How Omni Bridge Works
55
---
66

7-
## Background
8-
97
The journey toward truly trustless cross-chain communication took a significant leap forward when the NEAR team [created the first trustless bridge with Ethereum](https://near.org/blog/the-rainbow-bridge-is-live) (Rainbow Bridge). This pioneering achievement demonstrated that completely trustless cross-chain communication was possible, marking a crucial step toward the vision of chain abstraction. However, this approach relied on implementing a NEAR light client directly on Ethereum - essentially requiring Ethereum to understand and verify NEAR's complex blockchain rules.
108

119
Omni Bridge introduces a more elegant solution using Chain Signatures. Instead of running light clients on each destination chain, it leverages Chain Signature's MPC Service to enable secure cross-chain message verification without the overhead of light client verification. This new approach reduces verification times from hours to minutes while significantly reducing gas costs across all supported chains.

docs/chain-abstraction/wallet.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,6 @@ id: wallet
33
title: Wallet Chain Key Rules
44
---
55

6-
## Overview
7-
86
In this article you'll find details on how to parse and present multichain transactions to the user so they can take an informed decision about their wallet's assets, while minimizing the number of times the user has to consent.
97
You'll also learn how to ensure that a signature on one chain is not used to take a meaningful action on another chain.
108

docs/chain-abstraction/what-is.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,6 @@ import Tabs from '@theme/Tabs';
66
import TabItem from '@theme/TabItem';
77
import {CodeTabs, Language, Github} from "@site/src/components/codetabs";
88

9-
# What is Chain Abstraction?
10-
119
Blockchain development today faces a critical challenge: users need to understand complex blockchain concepts, manage multiple wallets, and deal with different networks just to use basic applications. Chain abstraction solves this by making blockchain technology invisible to end users while preserving all of the underlying benefits.
1210

1311
![img](/docs/assets/welcome-pages/2.chain-abstraction.png)

docs/data-infrastructure/big-query.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,10 @@ title: BigQuery Public Dataset
44
sidebar_label: BigQuery
55
---
66

7+
This document provides an overview of the BigQuery public dataset that allows users to query historical on-chain data from the NEAR Protocol. It includes setup instructions, example queries, and information about the available data structures.
8+
9+
# NEAR Public Lakehouse
10+
711
Blockchain data indexing in NEAR Public Lakehouse is for anyone wanting to understand blockchain data. This includes:
812

913
- **Users**: create queries to track NEAR assets, monitor transactions, or analyze on-chain events at a massive scale.

docs/data-infrastructure/indexers.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,6 @@
22
sidebar_label: "Intro to Indexers"
33
---
44

5-
# Introduction to Indexers
6-
75
Here you will find everything you need to know in order to familiarize yourself with the concept of indexers and even build your own one.
86

97
:::info Disclaimer

docs/data-infrastructure/lake-framework/building-indexers/js-lake-indexer.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,20 +3,20 @@ id: js-lake-indexer
33
title: JS basic tutorial
44
sidebar_label: JS basic tutorial
55
---
6+
This tutorial will guide you through creating a simple indexer using the JavaScript version of the NEAR Lake Framework. The indexer will print block height and number of shards to the console.
67

7-
# NEAR Lake indexer basic tutorial
8+
# NEAR Lake Framework JavaScript Indexer Tutorial
89

10+
Recently we have [published a JavaScript version of the NEAR Lake Framework](https://www.npmjs.com/package/near-lake-framework) on npmjs.org
11+
12+
We want to empower you with a basic tutorial on how to use the JavaScript Library. Let's get started!
913

1014
:::info Source code for the tutorial
1115

1216
[`near-examples/near-lake-raw-printer-js`](https://github.com/near-examples/near-lake-raw-printer-js): source code for the tutorial on how to create an indexer that prints block height and number of shards
1317

1418
:::
1519

16-
Recently we have [published a JavaScript version of the NEAR Lake Framework](https://www.npmjs.com/package/near-lake-framework) on npmjs.org
17-
18-
We want to empower you with a basic tutorial on how to use the JavaScript Library. Let's get started!
19-
2020

2121
## Requirements
2222

docs/data-infrastructure/lake-framework/building-indexers/nft-indexer.md

Lines changed: 8 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2,24 +2,22 @@
22
sidebar_label: NFT Indexer
33
---
44

5-
# Building an NFT indexer
5+
This tutorial will guide you through building a simple NFT indexer using the JavaScript version of the [NEAR Lake Framework JS](/data-infrastructure/lake-framework/near-lake-framework). The indexer will listen for `nft_mint` events and print relevant data about newly minted NFTs.
66

7+
The indexer is watching for `nft_mint` [Events](https://nomicon.io/Standards/EventsFormat) and prints some relevant data:
8+
- `receiptId` of the [Receipt](/data-infrastructure/lake-data-structures/receipt) where the mint has happened
9+
- Marketplace
10+
- NFT owner account name
11+
- Links to the NFTs on the marketplaces
12+
13+
The final source code is available on the GitHub [`near-examples/near-lake-nft-indexer`](https://github.com/near-examples/near-lake-nft-indexer)
714

815
:::note Source code for the tutorial
916

1017
[`near-examples/near-lake-nft-indexer`](https://github.com/near-examples/near-lake-nft-indexer): source code for this tutorial
1118

1219
:::
1320

14-
## The End
15-
16-
This tutorial ends with a working NFT indexer built on top [NEAR Lake Framework JS](/data-infrastructure/lake-framework/near-lake-framework). The indexer is watching for `nft_mint` [Events](https://nomicon.io/Standards/EventsFormat) and prints some relevant data:
17-
- `receiptId` of the [Receipt](/data-infrastructure/lake-data-structures/receipt) where the mint has happened
18-
- Marketplace
19-
- NFT owner account name
20-
- Links to the NFTs on the marketplaces
21-
22-
The final source code is available on the GitHub [`near-examples/near-lake-nft-indexer`](https://github.com/near-examples/near-lake-nft-indexer)
2321

2422
## Motivation
2523

0 commit comments

Comments
 (0)