gristlabs/grist-core

Some API endpoints are hidden from the reference documentation TOC

Open

#896 opened on Mar 14, 2024

View on GitHub
 (1 comment) (2 reactions) (0 assignees)TypeScript (168 forks)batch import
good first issue

Repository metrics

Stars
 (3,613 stars)
PR merge metrics
 (Avg merge 11d 9h) (47 merged PRs in 30d)

Description

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.

Contributor guide

Research direction
Check the documentation source to find where API endpoints are listed and add the missing `sql` and other hidden endpoints to the table of contents.
Tech stack
typescript
Domain
documentationbackend
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
None
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90