Skip to content

Migrate API docs to GitBook/alternative? #123

@pluma

Description

@pluma

The API docs are becoming a bit unwieldy, nearing 100 kB. NPM has started cutting the README.md off mid-sentence. Bumping the version for documentation updates is also a bit silly. We need something smarter than just dumping it all in README.md and praying for the best.

It's probably a good idea to switch to GitBook which is used by ArangoDB and other JS projects (e.g. Redux).

Metadata

Metadata

Assignees

Labels

DiscussionWarrants further discussion. Probably an incomplete feature request.DocumentationIssue concerns missing or incorrect documentation.

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions