Vue-resource: Improve documentation

Created on 18 Mar 2016  路  2Comments  路  Source: pagekit/vue-resource

Hi, thanks for this repo, is really useful and well done. However, I think that the docs can be improved a lot. It happens to me that when I have a specific issue with vue-resource I have to dig into the issues and pull requests to find an answer, so I suggest to improve documentation, by creating a gh-pages branch, and using gitbook like vue-router and vuex does.

What I would add to existing documentation

  • A litle bit about CORS usage
  • Examples and reference of file transfer
  • Better examples of interceptors usage
  • A whole topic about testing
  • And maybe a FAQ section with the most repeated issues?

thanks for readings :smile:

Most helpful comment

@YerkoPalma Thanks for your suggestions. Currently all documentation files are in /docs in folder. If you like help me out on a topic you suggested, please send me a pull request. Gitbook looks nice, i will try to move the current docs to gh-pages.

All 2 comments

@YerkoPalma Thanks for your suggestions. Currently all documentation files are in /docs in folder. If you like help me out on a topic you suggested, please send me a pull request. Gitbook looks nice, i will try to move the current docs to gh-pages.

I don't know if you have already submitted a PR. But the finally clause is a good thing to document. Although it's part of native JS, the changes on the API compared to the native fetch may make someone else confused.

Was this page helpful?
0 / 5 - 0 ratings

Related issues

Jigsaw5279 picture Jigsaw5279  路  5Comments

santigraviano picture santigraviano  路  5Comments

mikeyao picture mikeyao  路  6Comments

ramstein74 picture ramstein74  路  3Comments

Dreampie picture Dreampie  路  3Comments