amirabiri
27-12-2010 16:55:41
Hi all,
Since I started with Mogre I thought of some improvements for the main wiki page. I was going to wait until I finished with the tutorials before I tackle it, but I couldn't bear it any longer so I came up with a suggestion for re-organizing it today. I'm putting it up here to see what everybody think.
The key principle is to break everything down to a small number of clearly separate areas. In cases where a lot of information is available - organized or disorganized - related to one topic, I would create another wiki page that gives an overview of that topic and then links to the various existing sources with some explanations, organiztion, grouping etc.
For example, currently there is an "Introduction" link which links to a forum post that mstoyke wrote, then there is a direct link to the SDK installer, then "IMPORTANT LINKS" which links to a page with a lot of links itself, starting with the main page itself again (?), then to various interesting forum threads, then to addons. After the "IMPORTANT LINKS" there is another link called "MOGRE Introduction" which gives some overview of Mogre and comparison with other wrappers, and then a link called "MOGRE Installation" with a comment saying it is outdated. So that's twice "Introduction" and twice "Installation".
While all these bits of information are useful and important, I believe there is an easier way to organize and present them. This is an illustration of what I have in mind more or less:
Every current link on the main page goes into one of the ones above. A few examples:
Since I started with Mogre I thought of some improvements for the main wiki page. I was going to wait until I finished with the tutorials before I tackle it, but I couldn't bear it any longer so I came up with a suggestion for re-organizing it today. I'm putting it up here to see what everybody think.
The key principle is to break everything down to a small number of clearly separate areas. In cases where a lot of information is available - organized or disorganized - related to one topic, I would create another wiki page that gives an overview of that topic and then links to the various existing sources with some explanations, organiztion, grouping etc.
For example, currently there is an "Introduction" link which links to a forum post that mstoyke wrote, then there is a direct link to the SDK installer, then "IMPORTANT LINKS" which links to a page with a lot of links itself, starting with the main page itself again (?), then to various interesting forum threads, then to addons. After the "IMPORTANT LINKS" there is another link called "MOGRE Introduction" which gives some overview of Mogre and comparison with other wrappers, and then a link called "MOGRE Installation" with a comment saying it is outdated. So that's twice "Introduction" and twice "Installation".
While all these bits of information are useful and important, I believe there is an easier way to organize and present them. This is an illustration of what I have in mind more or less:
Every current link on the main page goes into one of the ones above. A few examples:
- All of the guides, code snippets, articles, howtos, and so can be grouped under one section, separate from the tutorials, but otherwise just one section. The idea behind this would be that a newcomer starts with the tutorials to get to a certain base level in a linear path, and from there on can pick and choose the guides, howtos and/or articles that interest them.[/*:m]
- All the links referring to the source code are moved to the "Developing Mogre" section (since it is not intended to build Mogre as part of the installation, only as part of development) - and will be detailed and explained under one page called "Mogre Source Code", which will refer to the various repositories, explain what is where, give an overview of the codebase perhaps, explain how to build the source code, and list the guidelines for contributing code / getting write access.[/*:m]
- The "Installation" page will provide a link to the SDK, but prior to that will include an explanation of what the SDK would provide and how to use it. The same section will then also discuss how one can manually assemble Mogre. And so on. [/*:m]
- An online code converter between C# and VB.NET, while no doubt a useful tool, is really outside the scope of the Mogre project. It can happily live in a wiki page that refers to various useful tools that can be used with Mogre ("tools").[/*:m][/list:u]
I haven't actually done any of this yet, as I've said I want to see what folks here think first. Once we get some agreement I would like to move forward quickly and start since there is a lot to do here and it feels a bit frustrating working on the tutorials when everything around them also needs a lot of attention.