gristlabs/grist-core

Some API endpoints are hidden from the reference documentation TOC

Open

#896 创建于 2024年3月14日

在 GitHub 查看
 (1 评论) (2 反应) (0 负责人)TypeScript (3,613 star) (168 fork)batch import
good first issue

描述

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.

贡献者指南

技术栈
typescript
领域
apidocumentation
议题类型
documentation
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
2
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
half day
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
fresh
清晰度议题是否清楚说明期望改动、验收标准和下一步。
clear
前置要求
Basic knowledge of Grist APIDocumentation generation tools
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
70
研究方向
The issue is that some API endpoints like 'sql' are missing from the reference documentation TOC. To fix this, investigate how the documentation TOC is generated in this project. Look for configuration files that define which endpoints are listed. Possibly there is a template or script that needs to include all endpoints. Check the repository's documentation folder and any related issues or PRs for context.