Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Write more documentation #17

Open
4 tasks
TheKnarf opened this issue Sep 4, 2018 · 0 comments
Open
4 tasks

Write more documentation #17

TheKnarf opened this issue Sep 4, 2018 · 0 comments
Labels
enhancement New feature or request

Comments

@TheKnarf
Copy link
Owner

TheKnarf commented Sep 4, 2018

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.org domain

  • Link too the .js.org page 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.

@TheKnarf TheKnarf added the enhancement New feature or request label Sep 4, 2018
@TheKnarf TheKnarf changed the title Use gitbook for documentation Write more documentation Jul 5, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant