jquery / jquery/jquery-wp-content

API Sites: Ability to publish pre-release docs

Open
#267 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Type: Improvement
Dominant language
PHP
Stars
260
Forks
170
PR merge metrics
No merged PRs in 30d

Description

Right now we don't publish API docs until there's a stable release. We should be able to publish docs during the pre-release phase and still have the unversioned URL show the stable docs.

Contributor guide

Open the contributing guide

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.

Research direction

No files, tests, or entry points are named. Start by tracing the API documentation publishing workflow and how stable versus pre-release versions are selected; done means pre-release docs can be published while the unversioned URL continues to serve stable documentation.

Written by the indexing model from the issue text.

Assessment

Domain
documentation, release
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.