gristlabs/grist-core

Some API endpoints are hidden from the reference documentation TOC

开放

#896 创建于 2024年3月14日

在 GitHub 查看贡献者指南
 (1 条评论) (2 个反应) (0 位负责人)TypeScript (168 个派生)batch import
good first issue

仓库指标

星标
 (3,613 个星标)
PR 合并指标
 (平均合并 11天 9小时) (30 天内合并 47 个 PR)

描述

Some API endpoint (such as sql) are hidden from the reference documentation TOC. The way it is presented makes it seems they are deprecated. I only discovered some of them while browsing the community forum.

贡献者指南

研究方向
问题是某些 API 端点（如 'sql'）未出现在参考文档的目录中。要解决此问题，请研究本项目中文档目录的生成方式。查找定义列出哪些端点的配置文件。可能需要修改模板或脚本以包含所有端点。检查仓库的文档文件夹以及相关 issue 或 PR 以获取上下文。
技术栈
typescript
领域
documentationbackend
议题类型
文档
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
1
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1-3 小时
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
活跃
清晰度议题是否清楚说明期望改动、验收标准和下一步。
清晰
前置要求
无
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
90