Skip to content

docs: update documentation content and structure#35

Open
2023478 wants to merge 5 commits intosipeed:mainfrom
2023478:main
Open

docs: update documentation content and structure#35
2023478 wants to merge 5 commits intosipeed:mainfrom
2023478:main

Conversation

@2023478
Copy link
Copy Markdown

@2023478 2023478 commented Apr 11, 2026

Summary

This PR improves documentation quality by refining content clarity, structure, and consistency across the updated pages. The goal is to make onboarding and feature discovery easier for users while keeping terminology and formatting aligned with project standards.

What Changed

  • Updated documentation text for clearer explanations and better readability.
  • Improved page structure and section flow in affected docs.
  • Standardized wording/terminology and markdown formatting.
  • Synced related localized docs where applicable.

Why

  • Reduce ambiguity in user-facing docs.
  • Keep documentation consistent across pages/locales.
  • Improve maintainability for future doc updates.

Scope

  • Documentation changes only.
  • No code logic, API behavior, or runtime configuration changes.

Validation

  • Verified markdown formatting and internal consistency.
  • Confirmed links/section references in updated pages.

Checklist

  • Documentation-only changes
  • No breaking changes
  • No security impact
  • Content reviewed for clarity and consistency


## 获取 API Key

1. 访问 Anthropic 控制台[ Anthropic Console](https://console.anthropic.com/),注册并登录
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
1. 访问 Anthropic 控制台[ Anthropic Console](https://console.anthropic.com/),注册并登录
1. 访问 Anthropic 控制台 [Anthropic Console](https://console.anthropic.com/)注册并登录


| 模型 | 输入(每百万 Token) | 输出(每百万 Token) |
| :---------------: | :------------------: | :------------------: |
| claude-sonnet-4.6 | \$3 | \$15 |
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

可以看看新的4.7?

Suggested change
| claude-sonnet-4.6 | \$3 | \$15 |
| claude-sonnet-4.7 | \$3 | \$15 |


### 第一步:访问平台

前往 [Try NVIDIA NIM APIs](https://build.nvidia.com/)NVIDIA Build 平台
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
前往 [Try NVIDIA NIM APIs](https://build.nvidia.com/)NVIDIA Build 平台
前往 [Try NVIDIA NIM APIs](https://build.nvidia.com/) NVIDIA Build 平台


### 第二步:创建 API Key

1. 点击右上角头像 → 选择 **API Keys**(直达:https://build.nvidia.com/settings/api-keys)
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

这里右括号被写进url里了

"group_trigger": {
"type": "discord",
"allow_from": [
"23123123123"
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

这里和英文的配置不对称

"model_name": "llama-3.3-70b",
"model": "groq/llama-3.3-70b-versatile",
"api_base": "https://api.groq.com/openai/v1"
},
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
},
}

Comment thread sidebars.js
Comment on lines +83 to +85
'providers/groq-api',
'providers/Anthropic-api',
'providers/NVIDIA-api',
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

这里统一全小写吧,跟随其它格式

@@ -0,0 +1,96 @@
---
id: Anthropic-api
title: Claude(Anthropic) API
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
title: Claude(Anthropic) API
title: Claude(Anthropic) API


config.json 配置

```
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
```
```json

包括其它代码块也一样,需要添加具体语言,才有高亮

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

groq和nvidia也要对应检查修改


`~/.picoclaw/.security.yml`:

```YAML
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
```YAML
```yaml

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants