search

FineUploader / fine-uploader

Multiple file upload plugin with image previews, drag and drop, progress bars. S3 and Azure support, image scaling, form support, chunking, resume, pause, and tons of other features.
https://fineuploader.com
MIT License
8.18k stars 1.87k forks source link

2 - Integrate Proofreader into docs site #1154

Open rnicholus opened 10 years ago

rnicholus commented 10 years ago

If this makes it easier for us and others to spot, report, and fix issues with the docs, we should definitely consider using it.

http://proofreader.hypervolume.com/

Mentioned in #1153.

feltnerm commented 10 years ago

It looks cool, but I'm not convinced that our users would actually use it. We'd need have to have it prominently displayed somewhere so they know it exists, and users would still need to post a new issue on GitHub. It just seems like a lot of steps to submit a spelling mistake.

One idea is to have a link directly to the source of each page on GitHub. A site I whipped up a while ago has an example of this. To the right of the post title there are a few links. 'v' takes you to GitHub to view the source and 'e' takes you to GitHub ready to edit the source. There are a few other links in that example that take you to the first or last commit (so you can see the diff over time) and the tag that that post is related to.

I could image the docs having small icons near the version at the top of the page that would take the users to a GitHub page where they could view the source and/or fork/pull-request easily for that page.

rnicholus commented 10 years ago

This is pretty much what Angular does for their docs. See the "Improve this doc" button at the top-right of any doc page at http://docs.angularjs.org/api.

feltnerm commented 10 years ago

This is pretty much what Angular does for their docs. See the "Improve this doc" button at the top-right of any doc page at http://docs.angularjs.org/api.

Simple, and I like it. :+1:

rnicholus commented 9 years ago

@feltnerm Any chance this will be done in the next week or so for 5.1.0?

rnicholus commented 9 years ago

pushed to 5.2

rnicholus commented 9 years ago

Doesn't look like this is going to happen any time soon, and I have more important cases to attend to. So, I'm going to refrain from tying this to a release and hope it is completed someday, but I'm not sure this is critical.