I basically agree with what you are saying. We should have the main documentation in the Sphinx, so that it can be doctested (maybe even most of it should actually be in the docstrings, so you can get to it from the interpreter using help()). Then, the more transient stuff should go in a wiki, which I guess should be GitHub (after only 5 min in the GitHub wiki, I already like it way better than the Google Code one: the markup is better, the previews are better, you can download/edit via git, etc.). This transient stuff is exactly the sort of thing that is in Google Code right now---GSoC, HowTos (like GettingTheBleedingEdge and UpdateMpmath), notes, etc..
So I vote to actually move some of the pages to the main documentation (the ones, like I said, that should be doctested), and the rest, including the ones in the Google Code wiki, to GitHub. But the MediaWiki is the priority, because it is costing Ondrej and is becoming overwhelmed with spam, not to mention that things like code blocks and LaTeX math do not work. And these should be the only two documentation sites. By the way, some pages could probably be thrown out completely if they are completely outdated. Was http://code.google.com/p/sfepy/w/list really supposed to be included in that list? Aaron Meurer On Fri, Nov 19, 2010 at 6:55 PM, Ondrej Certik <ond...@certik.cz> wrote: > On Fri, Nov 19, 2010 at 5:42 PM, Renato Coutinho > <renato.couti...@gmail.com> wrote: >> Hi, >> >> On Fri, Nov 19, 2010 at 10:08 PM, Aaron S. Meurer <asmeu...@gmail.com> wrote: >>> I noticed that renatocoutinho started porting some of the pages (like >>> https://github.com/sympy/sympy/wiki/Quick-examples/_history). Thanks for >>> that! >> >> Yes, I started to play with it, I have some handy regexps if anyone is >> interested. >> >> But now I'm somewhat confused, there are several sources of >> documentation, and I don't know what each one should contain: >> >> https://github.com/sympy/sympy/wiki >> http://wiki.sympy.org/wiki/Main_Page >> http://code.google.com/p/sfepy/w/list >> http://docs.sympy.org/ >> http://sympy.googlecode.com/svn/api/sympy.html >> >> My opinion is that we should have documentation centralized, and by >> far the most beautiful and well organized is in docs.sympy.org (the >> github math mode is ugly and doesn't show formulae correctly for me >> sometimes). >> >> Having a wiki, though, is also nice, we can replace the googlecode and >> mediawiki with the github one. There's much redundancy between the >> wiki and the main documentation (docs.sympy.org), so it looks unclear >> to a newcomer which is THE documentation, especially because the wikis >> are easy to find and don't even refer to the main doc page. Maybe the >> wiki should have specialized uses, like gsoc, plans and ideas, >> cookbook etc. and leave most of the usual docs to the docs.sympy.org >> page. > > I totally agree with everything you wrote and thanks so much for the > initiative! > > Yes, we should port all docs from the wiki into docs.sympy.org. > >> >> I also think that a better structure in the wiki would be nice >> (hierarchical instead of a list of all pages). I can do that, if >> people don't like it, it's easy to revert back. > > Yes, please go ahead. > >> >> I don't know what is the status of the api documentation in >> googlecode, there are references to it in the mediawiki wiki, several >> of them broken. > > I vote for removing that api. I'll wait if there are any objections, > and if not, I'll go ahead and remove it. > > Ondrej > > -- > You received this message because you are subscribed to the Google Groups > "sympy" group. > To post to this group, send email to sy...@googlegroups.com. > To unsubscribe from this group, send email to > sympy+unsubscr...@googlegroups.com. > For more options, visit this group at > http://groups.google.com/group/sympy?hl=en. > > -- You received this message because you are subscribed to the Google Groups "sympy" group. To post to this group, send email to sy...@googlegroups.com. To unsubscribe from this group, send email to sympy+unsubscr...@googlegroups.com. For more options, visit this group at http://groups.google.com/group/sympy?hl=en.
