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

docsprint to update documentation #224

Closed
marcoscaceres opened this issue May 22, 2013 · 6 comments
Closed

docsprint to update documentation #224

marcoscaceres opened this issue May 22, 2013 · 6 comments

Comments

@marcoscaceres
Copy link
Member

We should try to organize a doc sprint (e.g., 1 hour), where a group of us get together (virtually) and update the documentation. If we get 3-5 of us together, each take a chapter, we could get it done quick.

@darobin
Copy link
Member

darobin commented May 23, 2013

I was thinking of using my geek week (W3C folks get one week where all they do is geek out on absolutely whatever, as opposed to the rest of the year when we geek out on just more or less whatever) for this, but if there are volunteers to help I'm more than happy to do this in sprints — you can count me in.

I reckon that a first pass might actually be more about reorganising the docs (what we already have, how to split the docs into smaller, clearer bits) than writing. WDYT?

@marcoscaceres
Copy link
Member Author

yeah, that makes sense - it would be good to think about how people approach the document to get just the bits they need. Be good to also centralize the documentation in the repo instead of at:
http://dev.w3.org/2009/dap/ReSpec.js/documentation.html

@darobin
Copy link
Member

darobin commented May 23, 2013

Yeah, I need to pull CVS out of my arse to make the above redirect to the version on GitHub.

Do you want to get a discussion about this rolling on spec-prod? I think we'll find volunteers.

@marcoscaceres
Copy link
Member Author

Sure! It might also be a fun thing to do at TPAC, if we can't do it earlier. Be nice to meet and chat with other Respec'ters and compare scars :)

@darobin
Copy link
Member

darobin commented May 23, 2013

We could, but I'd like to get the docs sorted earlier than that. Also, TPAC is usually very busy :) But a breakout session on ReSpec might be good indeed.

@darobin
Copy link
Member

darobin commented Sep 26, 2013

This has been taken care of, see https://github.com/darobin/respec-docs/ to contribute.

@darobin darobin closed this as completed Sep 26, 2013
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

2 participants