Here's a vague plan for documentation. 1. Everyone, including lurkers please .. participate in documentation :) It's a lot of work. The success of the project *depends* more on the documentation than the actual technology now, since the technology is now so dang good, despite bugs and problems, Felix is just awesome, and the only way to improve the technology is to get more developers and more users .. and that depends on documentation.
No way *I* would use Felix or any other product unless it had good documentation, and Felix just doesn't. 2. The libraries have to be browsable. Even with all the warts and crud associated with real world libraries, reading library code online is better than no documentation. 3. I have made repeated attempts to get the "starting" tutorial better. However I never seem to get around to the advanced topics :) For example, polymorphism, type classes, C bindings, and stuff like "how do I do plugins". 4. Demos. We need these to be documented and actually work. SDL demos got broken by the switch to abstract integers. SDL is defined in terms of exact integers, but the code uses int, long, etc. The webserver/wiki demos are cool and can be used online, but I have no idea how to build or deploy them. I did it, but I forget .. :) 5. Integration with code. Needs to be improved. Tutorial code doesn't get tested for bugs now (it used to with the old interscript literate programming system). It is not (yet) possible to yank part of a code file into the documentation. We also need some kind of indexing system. 6. Doc organisation. At the moment there's the home page, a couple of auxilliary pages (community, download) and the generated tutorial index. I moved the advocacy stuff out to a separate suite. I would like the docs to be readable on a phone, so big fancy pages are out. To some extent, both manual and automatic page organisation is a failure compared to a Wiki model. In a wiki, everything is just a page with links, but the links get managed better. Its very hard to link to, say, numbered tutorial pages since the numbering changes. -- john skaller skal...@users.sourceforge.net http://felix-lang.org ------------------------------------------------------------------------------ This SF email is sponsosred by: Try Windows Azure free for 90 days Click Here http://p.sf.net/sfu/sfd2d-msazure _______________________________________________ Felix-language mailing list Felix-language@lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/felix-language
