Documentation todo - LuxRender Wiki

Documentation todo

Personal tools

From LuxRender Wiki

Jump to: navigation, search

This page is a list of various tasks that need to be done in order to improve the documentation. If you want to help out, just pick any item and start working on it. The issues that have a name between brackets behind them are currently being worked on. If you have any questions, just ask on the forum or IRC channel. If you're planning to contribute regularly, please contact Abel on the forum or IRC (luxrender@freenode).

current tasks

create / improve content

create an artist friendly feature list

There should be a page that gives potential new users an overview of what LuxRender can do in a single page, including both images and text. A good example is http://www.blender.org/development/release-logs/blender-243/. Currently, the page doesn't even exist, so thinking about which features should be presented would already be a step forward.

LuxRender manual (general)

Undoubtedly, there are features and settings that have not yet been documented and with the program being developed, more may be added while others become obsolete. When encountering such a feature, either describe it in the appropriate page or add it to this page so others know about it.

materials page

  • add description/examples of glass presets
  • document the architectural glass setting

lighting page

All available light types are now listed, but they lack examples. Some nice small renderings showing the effect of light settings should be added.

camera page

  • render better DOF examples

currently, the focus is on different objects for the examples; it would be less confusing to focus on just one object.

  • write about tonemapping

glossary

  • describe items without description
  • add terms, if necessary

render settings page

  • add descriptions, recommendations

FAQ

  • organise into clear categories
  • add questions

create 'tips and guidelines' page in LuxRender manual

  • describing characteristics of unbiased rendering
  • write about improving render times
  • show examples of transparent objects and the effect of air gaps between objects

write tutorials

write tutorials about using exporters, lighting setup, ...

find out how to...

  • how do we make a sure that material previews have the same brightness?
  • how can we change the default layout of tables, so that there will be visible borders by default?
  • how can we visually stress notes and warnings in a good looking and convenient way?

think about...

guidelines on spelling, capital letters, style for variables, tables

propose a clear, consistent and convenient graphical style to indicate areas on screen shots

continuous tasks

follow discussion of new futures on the forum and document them

follow user problems on the forum and IRC channel and add them to the FAQ

future tasks

The following tasks will need to be done at some point, but considering the state of development now is not the right time.

write tutorials

start material library

create new materials for the material library

start translated pages

improve/rewrite LuxBlend documentation

create tone mapping page

write about how LuxRender deals with units (meters etc.)