Skip to content

docs: add task navigation to the quickstart #49

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.

Sign up for GitHub

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

Merged
gjwang merged 1 commit into from
Nov 11, 2026
Merged

docs: add task navigation to the quickstart #49

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
12 changes: 12 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,18 @@ TypeScript and Python examples for AI agents and automated scripts. Start with a

Agents working from a clone can start with [AGENTS.md](AGENTS.md) to choose documentation, public-read or account examples.

## Choose your first task

| Task | Start here |
| --- | --- |
| Ask a setup question | [Documentation skill](#ask-a-documentation-question-with-an-agent-skill) or [Python MCP client](#read-documentation-from-a-python-agent) |
| Read documentation from your framework | [LangChain](#read-the-same-page-with-langchain) · [Google ADK](#read-documentation-with-google-adk) · [Pydantic AI](#read-documentation-with-pydantic-ai) · [OpenAI Agents SDK](#read-documentation-with-the-openai-agents-sdk) · [mcp-use / Node.js](#read-documentation-with-mcp-use-nodejs) |
| Check a chain ID | [Python without cloning](#check-a-chain-without-cloning) or [local Python](#python-standard-library-entry) |
| Check chain ID and read a block number | [TypeScript public reader](#start-with-a-keyless-read) |
| Create or reuse an account/key, then call Data API | [Full onboarding setup](#installation--setup) and [run instructions](#running-the-quickstart) |

Documentation and public-read examples need no BlockVectra account or key. `npm start` runs the full onboarding flow and can create a wallet, account and API key. Each entry below lists its prerequisites and request limits.

## Check a chain without cloning

With [uv](https://docs.astral.sh/uv/) installed, you can run the pinned script without cloning. This command selects Mode mainnet:
Expand Down
12 changes: 12 additions & 0 deletions README.zh.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,18 @@

克隆仓库后，Agent 可先读 [AGENTS.md](AGENTS.md)，按任务选择文档查询、公开读取或账户示例。

## 按任务选择入口

| 任务 | 从这里开始 |
| --- | --- |
| 查询接入文档 | [文档 Skill](#用-agent-skill-查询文档) 或 [Python MCP 客户端](#从-python-agent-读取文档) |
| 在现有框架中读取文档 | [LangChain](#通过-langchain-读取同一页面) · [Google ADK](#用-google-adk-读取文档) · [Pydantic AI](#用-pydantic-ai-读取文档) · [OpenAI Agents SDK](#用-openai-agents-sdk-读取文档) · [mcp-use / Node.js](#使用-mcp-use-读取文档nodejs) |
| 核对 chain ID | [不克隆仓库的 Python 入口](#不克隆仓库先校验链身份) 或 [本地 Python](#python-标准库入口) |
| 核对 chain ID 并读取区块号 | [TypeScript 公开读取](#先做无-key-读取) |
| 创建或复用账户和 Key，再调用 Data API | [完整接入配置](#安装与配置) 与 [运行说明](#运行示例) |

文档查询和公开读取示例不需要 BlockVectra 账户或 Key。`npm start` 运行完整接入流程，可能创建钱包、账户与 API Key。各入口下方列有环境要求和请求限制。

## 不克隆仓库，先校验链身份

已安装 [uv](https://docs.astral.sh/uv/) 时，可以不克隆仓库，直接运行固定源码版本的脚本。以下命令选择 Mode 主网：
Expand Down
Loading