Skip to content

Reorganize API docs in repo #316

Closed
Closed
@rwstauner

Description

@rwstauner

I've imported the API-docs wiki page into a new docs folder in this repo to increase the visibility of changes.

@oiami We'd like you to reorganize the public docs.
The single page is very long now, so feel free to break it up into separate files as you see fit.

This will be a good opportunity for you to increase your understanding of the project overall. Read through that page and ask questions about anything that we haven't discussed yet or anything you don't understand. Start a new pull request and push your changes to it as you go along so we can discuss it.

You may find that some of the example searches would be good to move into the examples repo. Feel free to make pull requests for that.

Use your discretion to try to improve the documentation, ask lots of questions, and make lots of changes! :-)

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions