Skip to content
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.

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

docs: optimize Graph API and data docs #6739

Merged
merged 8 commits into from
Feb 27, 2025
Merged

docs: optimize Graph API and data docs #6739

merged 8 commits into from
Feb 27, 2025

Conversation

yvonneyx
Copy link
Contributor

@yvonneyx yvonneyx commented Jan 21, 2025

  • 将原 【API-数据】下的内容挪到 【文档-核心概念-数据】
  • 将原【API-图API】挪到【文档-图实例 API】并按功能拆分文件,不走脚本自动生成,改手写

改造前:[脚本自动生成] 所有 Graph API 都写在一个文件里,内容很多,并且只有简单说明,复杂类型用外链的方式说明。

image

改造后:[手写] 按功能拆分,补充使用示例并完善描述。类型在同一个文件中说明。

image

@yvonneyx yvonneyx changed the title docs: adjust docs framework WIP: docs: adjust docs framework Jan 21, 2025
@yvonneyx yvonneyx changed the title WIP: docs: adjust docs framework docs: optimize Graph API and data docs Feb 26, 2025

```javascript
// ❌ 不推荐:在数据中直接包含样式
const badPractice = {
Copy link
Contributor

Choose a reason for hiding this comment

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

这里是手写的文档吗,在数据中直接包含样式其实也是可以的,怎么成了 bad practice 了呢

Copy link
Contributor Author

Choose a reason for hiding this comment

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

那我删了吧,感觉把样式写在数据里不太好,属于可以但不推荐的范畴

@yvonneyx yvonneyx merged commit 7c9763b into v5 Feb 27, 2025
2 checks passed
@yvonneyx yvonneyx deleted the refactor-docs branch February 27, 2025 04:39
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