-
Notifications
You must be signed in to change notification settings - Fork 1.4k
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
Improve documentation #160
Comments
Are you open to github-pages documentation, or do you want to keep it all in the README? http://documentation.js.org/ looks interesting. (particularly this demo) Also, you probably want to reserve |
I would prefer to keep it in the readme for now. I plan on having a website for AVA, but not until after 1.0.0. I want to focus on AVA itself for now. Marketing can be prioritized later.
Indeed. There's also https://readme.io/ (free for open-source).
I already have https://ava.li. |
Wow, documentation.js produces really nice output. Even the base output is pretty slick. Each method has a link to the source on GitHub (that works really well). Base types automatically link to |
Another plus for generation API docs using some JSDoc based system is that it improves typing hints on Webstorm significantly (I am assuming other IDE's as well). |
Agreed, documentation.js looks really good. Not a big fan of JSDoc. If I wanted type-hints I would go with Facebook Flow. |
@jamestalmage I opened a separate issue for a future website: #162 |
The documentation should cover how to get AVA working with production code. There is a lot of confusion #111 It should incorporate the code from this comment. It gets the point across pretty quick |
I said this on Gitter but putting it out here for further discussion: In the async function support section, I think a short explanation of what Also willing to help with commenting functions for documentationjs. |
@sotojuan I'm all for that, but would prefer to keep it succinct and rather link to a good blog post or two with more comprehensive explanation. |
We're now also looking for people interested in translating the docs: https://github.com/sindresorhus/ava-docs |
We've worked hard on making the documentation good, but we're biased as we made this thing and don't see it the way a first time users see it.
Documentation improvements of any kind are much appreciated. Anything to make things more explicit, more examples, fix grammar, anything.
The text was updated successfully, but these errors were encountered: