API Documentation missing

Open
#1,118 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
35/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale
Tech stack
graphql, php
Domain
api, documentation

Research direction

Start by locating the Bolt 4 API documentation area and the existing API platform reference. Gather the requested explanations, screenshots, common REST and GraphQL examples, and deeper pointers to the underlying API platform. Done means all listed documentation topics are covered and the checklist is complete.

Written by the indexing model from the issue text.

Description

We are missing API documentation for Bolt 4.

It should feature:

  • explanation + screenshots
  • examples of common REST and GraphQL requests
  • More in-depth pointers and reference to API platform, the underlining tool on which Bolt's API is built.
Dominant language
PHP
Stars
45
Forks
189
No merged PRs in 30d

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from bolt/docs

All issues in bolt/docs

Similar issues

More PHP issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.