Thanks for the detailed suggestions! First and second main points sound great to me. We should add those to the docs plan.
I am not familiar with Trello, but will look into it. But I suspect anything very organized is more formal than this open source project can tolerate ;) I mean, it would likely get out of date quickly. I suspect the demo list should stay on the current wiki, and not be part of the documentation revamp. Yes, we certainly need to keep it up to date and add links to code etc. as you suggest. Table format would be good also. If you or anyone else wants to do that, that would be great. - Alon On Tue, Jun 24, 2014 at 4:03 AM, Warren Seine <[email protected]> wrote: > Regarding the documentation content, here's what I would suggest: > > - refactor the Technical Documentation into a User Guide > - remove any specific page from the main page (like "EGL support in > Emscripten" or "Running html files with emrun") > - turn each subpage into an action (like "Compiling", "Binding", > "Embedding", "Running", "Debugging", "Packaging", "Publishing") > - in a "Publishing", explain how to properly embed an Emscripten > application (right now, I'm sure everybody copy/paste the generated HTML > and hack it) > - make first time access easier > - make sure the Tutorial is the first thing people go through (I > think it's good and should be highlighted even more) > - make a gist to build from source (I've made one > <https://gist.github.com/warrenseine/1d41aa6f0e28ed6c139c> but it's > somehow broken) instead of listing steps for Linux (and remove any old > confusing third-party links) > - move all screencasts, blog posts (official and unofficial), > tutorials and slides out of the User Guide > - move any "Issues" subsection into one Troubleshooting page with > complete error messages (so it can be indexed and searched) > - detail the project status > - turn the roadmap into a Trello board > <https://trello.com/board/meteor-roadmap/508721606e02bb9d570016ae> > - introduce the core team in a single place (with Twitter and > GitHub handles, blogs) > - clean up the demo list > - separate demos from tools / engines / libraries (it's somehow > confusing right now) > - update the demo list with direct link to the code (if available) > and the actual demo > - format it as a table ("name", "description", > "author", "submission date", "demo link", "source code") > > I know it's a big list. What do you think? > > -- > You received this message because you are subscribed to the Google Groups > "emscripten-discuss" group. > To unsubscribe from this group and stop receiving emails from it, send an > email to [email protected]. > For more options, visit https://groups.google.com/d/optout. > -- You received this message because you are subscribed to the Google Groups "emscripten-discuss" group. To unsubscribe from this group and stop receiving emails from it, send an email to [email protected]. For more options, visit https://groups.google.com/d/optout.
