Skip to content

Commit f489f89

Browse files
authored
Merge pull request #1537 from onflow/llm_build_doc_edits_cws
Llm build doc edits cws
2 parents edfc0cf + 52edefd commit f489f89

File tree

6 files changed

+321
-324
lines changed

6 files changed

+321
-324
lines changed

docs/blockchain-development-tutorials/forte/fixed-point-128-bit-math.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ After three-to-four sequential operations, significant cumulative rounding error
5959

6060
[`DeFiActionsMathUtils`] solves this with `UInt128` to represent fixed-point numbers with 24 decimal places (scaling factor of 10^24). This provides 16 additional decimal places for intermediate calculations, dramatically reducing precision loss.
6161

62-
:::Warning
62+
:::warning
6363

6464
There is still some precision loss occurring, but it is much smaller than with eight decimals.
6565

docs/blockchain-development-tutorials/use-AI-to-build-on-flow/index.md

Lines changed: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -21,24 +21,24 @@ keywords:
2121

2222
# Use AI To Build On Flow
2323

24-
Artificial Intelligence tools can significantly enhance your Flow development experience by providing intelligent assistance, code generation, and documentation access. This tutorial series will guide you through integrating various AI tools with Flow development to boost your productivity and code quality.
24+
Artificial Intelligence (AI) tools can significantly enhance your Flow development experience by providing intelligent assistance, code generation, and documentation access. This tutorial series will guide you through integrating various AI tools with Flow development to boost your productivity and code quality.
2525

2626
## What You'll Learn
2727

2828
In this tutorial series, you'll discover how to:
2929

30-
- Configure AI-powered development environments for Flow
31-
- Access Flow documentation directly from AI assistants
32-
- Generate Cadence and Solidity code with AI assistance
33-
- Debug and troubleshoot Flow applications with AI support
34-
- Leverage AI for testing and optimization
35-
- Build AI agents that interact with Flow using AgentKit
30+
- Configure AI-powered development environments for Flow.
31+
- Access Flow documentation directly from AI assistants.
32+
- Generate Cadence and Solidity code with AI assistance.
33+
- Debug and troubleshoot Flow applications with AI support.
34+
- Leverage AI for testing and optimization.
35+
- Build AI agents that interact with Flow using AgentKit.
3636

3737
# AI Tutorials for Flow
3838

3939
## Using Claude Code with Flow
4040

41-
Master systematic AI-powered Flow development with Claude Code, a terminal-integrated coding assistant designed for iterative blockchain development. This comprehensive guide teaches you to implement a four-stage development methodology (Idea → Visualization → Planning → Build) while leveraging unlimited context windows, subagent capabilities, and persistent project memory. Learn to configure CLAUDE.md files for Flow-specific instructions, integrate MCP servers for blockchain interactions, and implement checkpoint-based workflows that ensure reliable smart contract development from emulator to mainnet deployment.
41+
Master systematic AI-powered Flow development with Claude Code, a terminal-integrated coding assistant designed for iterative blockchain development. This comprehensive guide teaches you to implement a four-stage development methodology (Idea → Visualization → Planning → Build) while leveraging unlimited context windows, subagent capabilities, and persistent project memory. Learn to configure `CLAUDE.md` files for Flow-specific instructions, integrate MCP servers for blockchain interactions, and implement checkpoint-based workflows that ensure reliable smart contract development from emulator to mainnet deployment.
4242

4343
Tutorial: [Claude Code for Flow Development]
4444

@@ -50,7 +50,7 @@ Tutorial: [Use Flow Knowledge Base in Cursor]
5050

5151
## Using Chat GPT with Flow
5252

53-
Build your own expert AI assistant by creating a custom GPT specifically engineered to master the Flow blockchain and its Cadence smart contract language. This specialized tool will act as your personal pair programmer, providing highly accurate and context-aware answers to your most challenging development questions. By doing this, you're not just using a generic AI; you're creating a specialist trained on the exact documentation, code patterns, and best practices relevant to your work.
53+
Build your own expert AI assistant by creating a custom GPT specifically engineered to master the Flow blockchain and its Cadence smart contract language. This specialized tool will act as your personal pair programmer, providing highly accurate and context-aware answers to your most challenging development questions. By doing this, you're not just using a generic AI, you're creating a specialist trained on the exact documentation, code patterns, and best practices relevant to your work.
5454

5555
Tutorial: [Use Flow Knowledge Base in ChatGPT]
5656

@@ -62,19 +62,19 @@ Tutorial: [Data Sources]
6262

6363
## Eliza Integration
6464

65-
Learn about using Eliza on Flow, a versatile framework for constructing sophisticated AI agents that communicate with users through natural language. This guide walks you through the entire process of configuring and launching an AI agent built with Eliza directly onto the Flow blockchain. You will discover how to engineer intelligent agents capable of comprehending and addressing user prompts, all while harnessing the power of Flow's inherently secure and scalable onchain infrastructure.
65+
Learn about how to use Eliza on Flow, a versatile framework for constructing sophisticated AI agents that communicate with users through natural language. This guide walks you through the entire process of configuring and launching an AI agent built with Eliza directly onto the Flow blockchain. You'll discover how to engineer intelligent agents capable of comprehending and addressing user prompts, all while harnessing the power of Flow's inherently secure and scalable onchain infrastructure.
6666

6767
Tutorial: [Eliza on Flow]
6868

6969
## Build AI Agents with AgentKit
7070

71-
Learn how to build AI agents on Flow with AgentKit, a versatile and modular developer toolkit that is not tied to any single platform. It is engineered to dramatically accelerate the process of building, deploying, and refining AI agents by supplying pre-configured environments and a library of ready-to-use templates. This guide will walk you through the steps to launch your own custom agent on Flow's EVM-compatible testnet, leveraging the powerful combination of the Langchain framework and Anthropic's Claude large language model.
71+
Learn how to build AI agents on Flow with AgentKit, a versatile and modular developer toolkit that is not tied to any single platform. It's engineered to dramatically accelerate the process of building, deploying, and refining AI agents by supplying pre-configured environments and a library of ready-to-use templates. This guide walks you through the steps to launch your own custom agent on Flow's EVM-compatible testnet, leveraging the powerful combination of the Langchain framework and Anthropic's Claude large language model.
7272

7373
Tutorial: [Build AI Agents with AgentKit]
7474

7575
## MCP Guides
7676

77-
Learn how to construct a custom Flow MCP (Model Context Protocol) server or utilize an existing one to empower your AI tools. These tutorials will guide you through the process of equipping your AI applications with the unique capability to directly interact with the Flow blockchain, enabling them to perform onchain operations and access real-time data.
77+
Learn how to construct a custom Flow MCP (Model Context Protocol) server or use an existing one to empower your AI tools. These tutorials guide you through how to equip your AI applications with the unique capability to directly interact with the Flow blockchain, which allows them to perform onchain operations and access real-time data.
7878

7979
Tutorial: [Flow MCP]
8080

@@ -86,22 +86,22 @@ Tutorial: [Cadence Rules]
8686

8787
## Best Practices
8888

89-
When using AI tools with Flow development:
89+
When you use AI tools with Flow development:
9090

91-
- Always verify AI-generated code against Flow documentation
92-
- Use specific prompts that reference Flow concepts and terminology
93-
- Combine AI assistance with your own understanding of Flow architecture
94-
- Keep your AI tools updated with the latest Flow documentation
95-
- Test AI-generated code thoroughly before deploying to production
96-
- Consider the security implications of AI agents interacting with your contracts
91+
- Always verify AI-generated code against Flow documentation.
92+
- Use specific prompts that reference Flow concepts and terminology.
93+
- Combine AI assistance with your own understanding of Flow architecture.
94+
- Keep your AI tools updated with the latest Flow documentation.
95+
- Test AI-generated code thoroughly before deploying to production.
96+
- Consider the security implications of AI agents interacting with your contracts.
9797

9898
## Next Steps
9999

100-
After completing these tutorials, you'll be equipped to leverage AI tools effectively in your Flow development workflow. Consider exploring our other tutorial series to deepen your understanding of Flow development:
100+
After compleyou completeting these tutorials, you'll be equipped to leverage AI tools effectively in your Flow development workflow. Consider exploring our other tutorial series to deepen your understanding of Flow development:
101101

102-
- [Cross-VM Apps][cross-vm-apps] - Build applications that integrate Flow EVM and Cadence
103-
- [Native VRF][native-vrf] - Implement verifiable random functions in your applications
104-
- [Token Launch][token-launch] - Create and launch tokens on Flow
102+
- [Cross-VM Apps][cross-vm-apps] - Build applications that integrate Flow EVM and Cadence.
103+
- [Native VRF][native-vrf] - Implement verifiable random functions in your applications.
104+
- [Token Launch][token-launch] - Create and launch tokens on Flow.
105105

106106
## Conclusion
107107

docs/blockchain-development-tutorials/use-AI-to-build-on-flow/llms/chatgpt.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -18,9 +18,9 @@ keywords:
1818

1919
# Use Flow Knowledge Base in ChatGPT
2020

21-
[ChatGPT] is an AI assistant developed by [OpenAI] that can help with tasks such as writing, coding, and answering questions. It adapts to context and user input to provide relevant, conversational responses. ChatGPT can be integrated into developer tools or workflows to assist with documentation, debugging, and productivity.
21+
[ChatGPT] is an AI assistant developed by [OpenAI] that can help with tasks such as writing, coding, and answering questions. It adapts to context and user input to provide relevant, conversational responses. You can integrate ChatGPT into developer tools or workflows to assist with documentation, debugging, and productivity.
2222

23-
This guide walks you through creating a **Custom GPT** using ChatGPT that can reference the [Flow Data Sources] file to answer questions.
23+
This guide walks you through how to create a **Custom GPT** with ChatGPT that can reference the [Flow Data Sources] file to answer questions.
2424

2525
<div style={{ position: 'relative', paddingBottom: '56.25%', height: 0, overflow: 'hidden', maxWidth: '100%' }}>
2626
<iframe
@@ -39,7 +39,7 @@ You'll need a [ChatGPT Plus subscription] to use the **Custom GPT** feature.
3939

4040
:::
4141

42-
## 📍 Step 1: Open the "Explore GPTs" Section
42+
## 📍 Step 1: Open the "Explore GPTs" section
4343

4444
1. Log in to [ChatGPT].
4545
2. In the sidebar on the left, click **Explore GPTs**.
@@ -50,31 +50,31 @@ You'll need a [ChatGPT Plus subscription] to use the **Custom GPT** feature.
5050

5151
## 📍 Step 2: Click "Create a GPT"
5252

53-
1. In the **Explore GPTs** screen, click the **"Create"** button in the top-right corner.
53+
1. In the **Explore GPTs** screen, click **"Create"** in the top-right corner.
5454

5555
![create](./imgs/create.png)
5656

5757
---
5858

59-
## 📍 Step 3: Walk Through the GPT Builder
59+
## 📍 Step 3: Walk through the GPT builder
6060

6161
ChatGPT will now guide you through a conversation to set up your custom GPT. First, drag and drop the [Flow Data Sources All Merged] file into the prompt.
6262

63-
### Suggested Prompt
63+
### Suggested prompt
6464

6565
```text
6666
I want to make a GPT called FlowGPT that uses the linked file as it's primary source. This file changes, so it should reference the live file at least once a day: https://github.com/onflow/Flow-Data-Sources/blob/main/merged_docs/all_merged.md
6767
```
6868

6969
---
7070

71-
## 📍 Step 4: Configure the GPT's Name and Instructions
71+
## 📍 Step 4: Configure the GPT's Nnme and instructions
7272

7373
ChatGPT may ask you to customize or verify:
7474

7575
- **Name and description** of your GPT
76-
- **Instructions**: Tell it how to behave and what to prioritize (e.g., always reference the uploaded document)
77-
- **Capabilities**: Enable file browsing, code interpreter, or DALL·E if needed
76+
- **Instructions**: Tell it how to behave and what to prioritize (for example, always reference the uploaded document)
77+
- **Capabilities**: Allow file browsing, code interpreter, or DALL·E if needed
7878

7979
We've found it helpful to suggest:
8080

@@ -86,13 +86,13 @@ Please let us know if you find any other useful customization prompts!
8686

8787
---
8888

89-
## 📍 Step 5: Test Your GPT
89+
## 📍 Step 5: Test your GPT
9090

91-
Once the GPT is built, you'll be taken to a preview chat window. Test it by asking a few questions based on your uploaded document.
91+
After the GPT is built, a preview chat window will appear. To test it, ask a few questions based on your uploaded document.
9292

9393
---
9494

95-
## 📍 Step 6: Save and Publish (Optional)
95+
## 📍 Step 6: Save and publish (optional)
9696

9797
When you're ready:
9898

0 commit comments

Comments
 (0)