Skip to content

Switch to gh-pages for api documentation #2

Description

@gbinal

When I arrive at https://github.com/usnationalarchives/Catalog-API, I see a lot of things which aren't the API documentation for this web service.

It would be much cleaner and developer-friendly if you use GitHub pages to create a microsite for the api documentation and drive people to that instead of the repo's readme.

There are several examples you can easily use here. Let me know if you need a hand.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Fields

    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions