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 (3,613 stars) (168 forks)batch import
good first issue

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

Tech stack
typescript
Domain
apidocumentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Basic knowledge of Grist APIDocumentation generation tools
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70
Research direction
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