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.

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

Jump to bottom

[Feature]: 添加一个使用文档吧 #24

Open
2 tasks done
hhhhhge opened this issue Jun 5, 2024 · 7 comments
Open
2 tasks done

[Feature]: 添加一个使用文档吧 #24

hhhhhge opened this issue Jun 5, 2024 · 7 comments
Labels
enhancement New feature or request

Comments

@hhhhhge
Copy link

hhhhhge commented Jun 5, 2024

确认项

  • 新特性的目的明确
  • 我已经使用过该项目并且了解其功能

希望能解决的问题

添加一个使用文档吧

描述所需要的功能

添加一个使用文档吧
@hhhhhge hhhhhge added the enhancement New feature or request label Jun 5, 2024
@hhhhhge
Copy link
Author

hhhhhge commented Jun 5, 2024

就比如其他的特性什么的都有哪些，那个小示例不太够

@RF-Tar-Railt
Copy link
Member

就比如其他的特性什么的都有哪些，那个小示例不太够

我觉得大部分内容通过阅读完satori文档和nb文档就能了解了

@RF-Tar-Railt
Copy link
Member

注意，satori-python 属于 SDK
如果想使用其功能请使用 Entari

@hhhhhge
Copy link
Author

hhhhhge commented Jun 8, 2024

在嘛，怎么调用平台api，格式是什么，没有文档我不知道

@RF-Tar-Railt
Copy link
Member

在嘛，怎么调用平台api，格式是什么，没有文档我不知道

平台特定api用bot.internal

@hhhhhge
Copy link
Author

hhhhhge commented Jun 8, 2024

能不能写一个文档嘛

@WindowsSov8forUs
Copy link
Contributor

对于具体的 Satori 协议用法，请参考 Satori 文档

文档中已经包含了绝大多数 Satori 协议的通用情况，一般条件下参考文档调用即可
具体的各 API 与消息元素等对应着什么请参考你所使用的 Satori 服务端平台，Satori 协议本身并不负责对各大平台的完全适配，适配如何仅由服务端的适配器实现决定，这里不会也做不到去详细描述各平台具体如何通过 Satori 协议通信

对于各平台的内部 API ，也在文档的 跨平台 一章中有所说明。我们无法将目前已实现适配器支持的 15 个平台的所有内部 API 一一列举出来，因此具体的实现与使用方法只能请你通过对应的 Satori 服务端文档和平台文档获取

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@RF-Tar-Railt @WindowsSov8forUs @hhhhhge