[GSoD 2019] Idea Discussion

Threads related to Google Summer of Code
Post Reply
OGRE Team Member
OGRE Team Member
Posts: 814
Joined: Sun Mar 30, 2014 2:51 pm
x 131

[GSoD 2019] Idea Discussion

Post by paroj » Wed Apr 03, 2019 11:11 am

One of the major complaints in this years survey, was the lack of up-to-data documentation:
https://docs.google.com/forms/d/e/1FAIp ... wanalytics

TOPIC # 1: Collect & update WIKI based tutorials
One part of the issue are our old wiki based tutorials. Those currently target Ogre <= 1.9 and do not use our simplified ApplicationContext class and generally use old practices.

Any documentation on the wiki also tends to fall out of date quickly. Therefore we introduced an unified documentation approach with Ogre 1.10, where tutorials are stored along the code in the git repository.
The tutorials are written in diffable & reviewable markdown, while referencing actual code that can be compile tested through Doxygen.

Unfortunately, so far we had only one external contributor porting content from the wiki to the new infrastructure:

An applicant should be familiar with C++ and work his way through the basic ported tutorials. Based on this, he should take a look at the remaining Wiki tutorials and port them to the new system. See the this pull request for reference.

TOPIC #2: Re-target existing documentation
Many parts of the OGRE user manual written from the implementors point-of-view instead of taking the user perspective. This makes it hard for potential users to derive the useful information.
An instance of this is the RTSS documentation. The according user complaint.

TOPIC #3: Write in-depth tutorials
The second documentation issue is the lack of tutorials on in-depth topics. While we have demos for advanced effects like
  • Bump Mapping
  • Cube Mapping
  • Volumetric Terrain
  • Particle System
  • Compositors
  • Particles
generally those only show code. It is desirable to have textual explanation as well.

The applicant should either be already familiar with the aforementioned Ogre concepts or be able to gather the necessary information from the Wiki and the API docs to write according tutorials.
0 x

Post Reply