-
Notifications
You must be signed in to change notification settings - Fork 2
Description
I'd like to setup a gitbook page for documentation. Originally I wanted to setup a gitbook page for isomorphic-jsx. However gitbook have moved away from being a documentation host where everything lives in the original git repo, as such it is no longer a good fit for my project. As such I'd rather either use RavenDesk or simply keep documentation as markdown files in this repo
-
Write documentation
-
Consider getting a
.js.orgdomain -
Link too the
.js.orgpage from github and project readme -
Is there some way that CI can check documentation? Perhaps for typos?
Documentation should contain:
-
A logo Logo #9
-
Comparisons to other libraries Comparison to other libraries #4
-
Instructions on how to setup with Express
-
Instructions on how to setup with Webpack
-
List of projects using Isomorphic-jsx
-
Example's one can use / take inspiration from
-
Potentially also a walkthrough of how the code works.