gristlabs/grist-core

Some API endpoints are hidden from the reference documentation TOC

Open

#896 opened on 2024年3月14日

GitHub で見る
 (1 comment) (2 reactions) (0 assignees)TypeScript (3,613 stars) (168 forks)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
Issue 種別
documentation
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
2
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
half day
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
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.
Some API endpoints are hidden from the reference documentation TOC · gristlabs/grist-core#896 | Good First Issue