Documentation

Description

Currently, the individual package documentation is lacking.

Each package should include the following

• Badges for build size, latest version, downloads / month, open pull requests by label, open issues by label, close prs by label, license, stars
• Integrate lgtm
• Logo on all readme.md pages
• Code examples for each package
• Include /packages with each package documented as a path in docs.remirror.org/packages/<package-name>
• Getting started guide i.e. by building an editor example
• Build an example extension guide

Example usage for:

• Twitter UI
• GitHub UI
• Floating Menu

User requested documentation

• [RenderTree] document how to configure RenderTree if Remirror has user-defined extensions like new marks or nodes #66
• [Remirror] document how to hook into Remirror events / prosemirror events
  • Is the way to do this by configuring proseMirror EditorProps on <Remirror> instance, i.e. something like <Remirror handleTripleClick={(view, pos, event) => { someCallback() }} />?
  • Or by configuring a Remirror extension - see @remirror/ui-twitter/src/components/ui-twitter.tsx#L84
• [tutorial] demonstrate how to set up Remirror editor that can toggle between markdown editing and toolbar editing just like https://prosemirror.net/examples/markdown/

[hcharley]

Small piece of feedback, that could be an easy todo:

It seems like headers in the docs are a bit inconsistent. It seems like we’d want to make sure each page has a similar title just to help users navigate and keep things looking clean.

For example: a page with a large title (h1)

For example: a page without a title

[ifiokjr]

@charlex I’ll get started on this probably towards the backend of this week.