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

Add API Documentation to README #173

Open
ajpiano opened this issue Jan 9, 2013 · 5 comments
Open

Add API Documentation to README #173

ajpiano opened this issue Jan 9, 2013 · 5 comments

Comments

@ajpiano
Copy link

ajpiano commented Jan 9, 2013

The docs for jQuery.tmpl are no longer included in api.jquery.com, and I don't foresee us adding them back to there. I think the best solution is to just include the API documentation in the README, as is popular for many open source projects of similar scale and complexity as jQuery.tmpl. Although the plugin is deprecated, it seems many are still reliant on it and the documentation should be somewhere.

This issue is essentially porting over @listrophy's tweet from earlier today, so thanks for that. https://twitter.com/listrophy/status/289041726864240640

@rdworth
Copy link
Contributor

rdworth commented Jan 9, 2013

+1

@felquis
Copy link

felquis commented Jan 14, 2013

+1 I needed this today, but.. =/

@waynedenier
Copy link

If anyone is still interested in this, I've submitted a pull request that should go towards correcting the issue. #175

@BorisMoore
Copy link
Owner

Very nice. Thanks Wayne. This leads the way. :). This is one topic, from the 13 that are listed here, so logically, this process could be continued to add the other twelve. (And then, for more fun, adding in the demos :))

I know a lot of folks are missing the docs a lot, so this is great. I did receive an email suggesting I add the docs to my blog, which could also be an option. Otherwise just adding to this README might be fine, especially if navigation between topics can be included, as hash anchor links, within the readme.md document... Maybe we should keep this issue open, since so far we just have one documentation topic out of 13.

@BorisMoore BorisMoore reopened this Jan 29, 2013
@BorisMoore
Copy link
Owner

I have changed the README and provided a link to the archived documentation. See #177

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

5 participants