API Website

[kanyewesternfront]

I have made a website for the API documentation for xhr-mock which is currently attached to my personal site.
website: http://elizabethjellison.com/xhr-mock/
repo: https://github.com/kanyewesternfront/xhr-mock
(the docs folder has been added under this repo)

This is the first time I've done this so if I anything, let me know!

[jameslnewell]

Thanks so much for spending time working on this!!!

The site you've created looks and functions fine, my only concerns are around maintaining the API documentation - the API docs are currently manually maintained and must be manually updated whenever the API is changed. With this PR there are now two places where the docs must be updated when the API changes. Do you have any suggestions for reducing this impact? Would something like this reduce a lot of the manual effort in keeping the docs up-to-date?

[kanyewesternfront]

One option we can consider, at least for now, is having one place where the API lives, on a website, with link to that API site on the xhr-mock github page, and a link to the xhr-mock github page on the npm page. Example Project: react-native-web

I don't mind taking things out of the website, so there isn't any redundancy, making it mostly pure API documentation.

As for how to make it easier, I've never used an automatic generator before, so it would be a good project for me to continue with, if you are okay with that.

[jameslnewell]

One option we can consider, at least for now, is having one place where the API lives, on a website, with link to that API site on the xhr-mock github page, and a link to the xhr-mock github page on the npm page.

Sounds like a good first step 👍

I don't mind taking things out of the website, so there isn't any redundancy, making it mostly pure API documentation.

Lets move it all to the website and just link to it like you say.

As for how to make it easier, I've never used an automatic generator before, so it would be a good project for me to continue with, if you are okay with that.

That would be really cool! But lets merge this first. How do I deploy it? Can you please add a script to deploy the website in a postpublish script so that I don't forget to upload the docs when I publish.

Thanks!

[kanyewesternfront]

Hey, sorry for the late reply.

I updated the pull request but I get a message saying the Travis CI build failed. Do you know how to fix this?

As for the website, its a static site made with Jekyll pages, so you will be able to publish it under your github account without any script. If you never used Jekyll, I've provided some instructions on how to publish the site below. If you already know, just ignore them!

After the pull request is accepted:

1. Go to your xhr repository
2. Go to Settings
3. Scroll down to GitHub Pages
4. Under Source select master branch/docs folder
5. Save
6. It will then publish and provide you a link under GitHub Pages

If you want to run this site locally:

1. Install Jekyll
2. Run 'bundle install' under docs folder
3. Run 'bundle exec jekyll serve'