gristlabs/grist-core

Some API endpoints are hidden from the reference documentation TOC

オープン

#896 opened on 2024/03/14

GitHub で見るコントリビューターガイド
 (1 件のコメント) (2 件のリアクション) (0 人の担当者)TypeScript (168 件のフォーク)batch import
good first issue

Repository metrics

Stars
 (3,613 個のスター)
PR merge metrics
 (平均マージ 11d 9h) (30d で 47 merged PRs)

説明

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.

コントリビューターガイド

調査方針
問題は、'sql' などの一部の API エンドポイントがリファレンスドキュメントの目次から欠落していることです。これを修正するには、このプロジェクトでドキュメント目次がどのように生成されているかを調査してください。どのエンドポイントがリストされるかを定義する設定ファイルを探します。すべてのエンドポイントを含める必要があるテンプレートやスクリプトがある可能性があります。リポジトリのドキュメントフォルダと、関連する issue や PR を確認してコンテキストを把握してください。
技術スタック
typescript
領域
documentationbackend
Issue 種別
ドキュメント
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
1
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
1-3時間
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
アクティブ
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
明確
前提条件
なし
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
90