Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

Make our documentation the best in the world #1

Open
@rmccue

Description

WP API's documentation should be first-class, and better than every other API out there. This might seem unachievable, but let's aim for it anyway. 🌠

The documentation itself currently lives in the main WP-API repo, but we can move it here if that works better.

How do we do this? Here's some initial things I can see that we need to do:

  • Include guides on the site
  • Include OAuth documentation on the site
  • Integrate all route documentation

This is a tracking ticket for everything else, let's talk about how to do this here, and handle specifics in individual tickets.

Stripe's API docs are widely considered some of the best, let's take inspiration from them where possible. Parse also has some great thoughts.

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions

        AltStyle によって変換されたページ (->オリジナル) /