yade-dev team mailing list archive

[Václav Šmilauer <eudoxos@xxxxxxxx>]

> I made some changes in wiki home.
> - I removed some pages (well, the pages are still there, I removed only 
> the links).
> - I listed a few of them for pending erase when I was not sure (bottom 
> of page, removed soon if no one complains).
OK, I updated that as well. Much more to remove IMHO...

> - Yade community
> - Yade overview, including exemple simulations, sceenshots and videos, 
> introduction to implemented models, and some general ideas one Yade usage.
> - Development (perhaps not all pages), which gives usefull information 
> on programming tools, but too general for Yade documentation.
Agreed, those are logical on the wiki.

> Not sure :
> - Python pages. They were very usefull for me. They are written in 
> beginner-friendly style, and I also tend to see them also as part of the 
> overview : it gives the taste of how Yade works before diving in a 
> technical documentation. I would keep them in the wiki, but maybe it 
> will be considered a duplicate of sphinx?
There is already the introductory chapter in sphinx,
https://yade-dem.org/sphinx/introduction.html . Perhaps it could contain
some example of a simple simulation as whole, something like
simple-scene perhaps, or at least a link to it.

> - Yade installation, I don't exactly know how much has to be updated in 
> those pages. Pages like "new to linux" might look naive but they could 
> be kept as somebody typed them and they can help people. Unlike python, 
> there is no real reason to keep installation on the wiki if installation 
> is detailed in Sphinx. OTOH, installation procedure changes frequently, 
> and a wiki is good for that (how do you Vaclav see the maintainance of 
> sphinx doc in the future btw?)
I think it does not change _that_ often, and it would make sense to make
it a part of sphinx. Sphinx docs are in trunk and people changing stuff
should update it themselves. I definitely will _not_ conpoensate
lazyness of other in this respect.

> I'd like a few good images in this first page too, any suggestion?

I would suggest to make the sphinx home https://yade-dem.org/sphinx/ as
the main page for http://www.yade-dem.org, and only reference wiki from
there. We wouldn't be the first ones to do that (e.g.
http://docs.python.org/ or http://matplotlib.sourceforge.net/)

Two other things:

1. I will convert Publications to bibtex so that they can be referenced
from documentation (and are included in the docs); if someone wants to
cite an article, it is easier to copy a paragraph from the bibtex file
rather than finding the article by title through scholar.google.com

Many of those articles are not online. I would strongly ask their
authors to post the pdf's to the wiki!!

2. I still see {{#ev:youtube|KUv26xlh89I}} instead of the video frame at
https://yade-dem.org/wiki/Screenshots_and_videos#Ball_Mill_-_125_000_spheres
I already pinged Remi on that without a reponse. Can you remind him,
Bruno, in case he doesn't read everything?

3. Screenshots should only show what is still functional. Cloth, FEM,
lattice, tetrahedra are not and should be removed from that page. Is
there an agreement?

v