Skip to content

Implement an API reference page #1401

Open
@infomiho

Description

@infomiho

We want to group all of the per-feature API references into one big API reference page.

If there is some API reference that doesn't belong into any feature page (unlikely) we can write it directly in the API references page.

Implementation

The way we can do it:

  1. Wrap each API reference in a React compnent
  2. Reuse the component in the feature page (e.g. Email API reference on the Email auth page)
  3. Reuse the component in the API reference page

Something like this:

docs/
-- email.md <------ imports EmailAPIReference.jsx
-- EmailAPIReference.jsx
api/
-- api.md <------ imports EmailAPIReference.jsx

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions