Code Monkey home page Code Monkey logo

go-cqhttp-docs's Introduction

Hi there 👋

go-cqhttp-docs's People

Contributors

01101sam avatar aicorein avatar crazywhalecc avatar dihechen avatar fi6 avatar frenqy avatar fywinds avatar gcpanic avatar giftia avatar huajimur233 avatar ink-33 avatar ishkong avatar lc6464 avatar lxy071130 avatar miaowuawa avatar mingxuangame avatar qianjunakasumi avatar saplonily avatar shudorcl avatar slimenull avatar starhearthunt avatar stellarpurr avatar vikiboss avatar wangrunlin avatar weltolk avatar xiyaowong avatar yepyuyu avatar yjrqz777 avatar yukari316 avatar zeithrold avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar

go-cqhttp-docs's Issues

对撤回的消息进行全员删除操作时报错

对撤回的消息进行全员删除操作时go-cqhttp本身报错

[2023-06-23 08:09:36] [ERROR]: 处理频道撤回事件时出现错误: 获取操作者资料时出现错误 fetch roles error: decode packet error: oidb result unsuccessful: 58002 msg: users not in guild

复现方法

在频道撤回消息后,将撤回的消息通知进行全员删除操作。该操作可能需要频道管理权限。

使用模板生成 API

感觉更加规范?
同时方便后面写 API 自动化更新(虽然好像更新频率也蛮低的)

apiVersion: generator/v1
metadata:
  apiVersion: v1
  commitId: 987daad785839a9cb0425a27edc90a0a695f5c84
  creationTimestamp: '2022-03-04T04:49:41Z'
spec:
  CQSendGroupMessage:
    metadata:
      type: group
      availableVersion: v1
      annotations:
    spec:
      name:
        metadata:
          autotype: true
        spec: 发送群消息
      endpoint: /send_group_msg
      description: |-
       发送群消息
      payload:
        metadata:
          annotations:
        spec:
          - name: group_id
            type:
              metadata:
                autotype: true
                link: none
              spec: int64
            default: none
            description: none
      response:
        metadata:
            annotations:
        spec:

随手搓的一个示例,不是定稿
现有格式都会被考虑在内

主要目的是生成风格统一的 API 详情页面,不用考虑排版问题。需要考虑时只需要修改一个地方然后用生成器生成就可以了

感觉咋样(

[feat]API文档添加绪论

  • 为全部API添加请求与返回例子

现有的gocq API文档是建立在用户充分了解OneBot协议之上的,对新接触机器人的用户来说并不友好。何况现在的API文档仅描述了HTTP的通信方式,对WSRWS的实现方法没有提及。综上,我认为有必要在/api下添加一个绪论,描述OneBot API基本通信原理,并附上OneBot的链接。

进行文档版本区分

Todo

  • 分版本构建文档
  • 使用 vuepress-plugin-versioning 处理
  • 使用自定义主题,从而在侧边栏加入文档版本选择下拉
  • 可以使用 NoneBot 文档已经做好的主题直接加入适配,或者做一个 gocq 版本的? (Request for Comments)

缺少文档补充

原 issue 为 #29

sam01101 的原帖内容
我这里做个mark, 等某天自己记起了过来处理

  • 补充 text 的CQ码说明
  • message chain 使用补充
  • Guide 中的 目录结构格式补充 (剩下 1 个)
  • CQ Code 中的 json 补充 (有必要看一次是不是完整了, 然后补充下添加的版本)
  • 二维码扫描补充
  • FAQ 水点东西进去
  • 补充文档 Mrs4s/go-cqhttp#796

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.