Adam's Lair Forum

game development and casual madness
It is currently 2017/03/28, 00:31

All times are UTC + 1 hour [ DST ]




Post new topic Reply to topic  [ 6 posts ] 
Author Message
 Post subject: Documentation Requests
PostPosted: 2016/09/04, 16:14 
Site Admin
Site Admin
User avatar

Joined: 2013/05/11, 22:30
Posts: 1935
Location: Germany
Role: Professional
Is there a topic you'd like to know more about? Request it here, so we can get to work documenting it! This will help us determine which topics are most wanted and / or lacking sufficient documentation. When documentation has been extended in response to a request, feel free to post in this thread about it as well.

Template for requests:
Quote:
Requesting: Docs Page / Tutorial
Topic: The headline / main theme of the topic you need.
Summary: Describe in a few short sentences what you would hope to learn more about from the documentation that will be written about this.

Code:
[b]Requesting:[/b] Docs Page / Tutorial
[b]Topic:[/b] The headline / main theme of the topic you need.
[b]Summary:[/b] Describe in a few short sentences what you would hope to learn more about from the documentation that will be written about this.


What's the difference between a Docs Page and a Tutorial?

  • Docs Page: Outlines functionality, usage and theory based on the described topic.
  • Tutorial: Outlines a sequence of actions based on a goal, while providing the subset of knowledge about the described topic that is required to do so.

Edit: For more advanced requests, complete with a list of topics and potential article structure, I have created a new GitHub milestone where one issue per requested Wiki article can be submitted. These issues can also be used for discussing progress and implementation of each article.

_________________
Blog | GitHub | Twitter (@Adams_Lair)


Top
 Profile  
 
PostPosted: 2016/09/04, 17:38 
Member
Member

Joined: 2016/06/30, 03:38
Posts: 58
Location: Portugal
Role: Hobbyist
Requesting: Docs Page
Topic: Cameras
Summary: I'd like to learn about how cameras work, how using multiple cameras work and how to correctly manipulate them in code and the editor (size, view-ports, positions, etc).


Top
 Profile  
 
PostPosted: 2016/09/05, 11:16 
Junior Member
Junior Member
User avatar

Joined: 2016/04/12, 01:18
Posts: 38
Location: Serbia
Role: Hobbyist
To add to this also overlays...


Top
 Profile  
 
PostPosted: 2016/09/05, 12:24 
Member
Member

Joined: 2015/12/27, 00:33
Posts: 76
Role: Hobbyist
Eldir wrote:
Requesting: Docs Page
Topic: Cameras
Summary: I'd like to learn about how cameras work, how using multiple cameras work and how to correctly manipulate them in code and the editor (size, view-ports, positions, etc).

mika76 wrote:
To add to this also overlays...

:+1:
I'd like to know what are camera passes and how to properly make an UI.


Top
 Profile  
 
PostPosted: 2016/10/01, 07:35 
Member
Member

Joined: 2015/11/04, 20:02
Posts: 69
Location: Canada
Role: Hobbyist
Here's a small list of topics I think would benefit most new people:

Requesting: Docs Page
Topic: Project View
Summary: What appears in it, and how to use it. Further reading: recommended directory structure

Requesting: Docs Page
Topic: Object Inspector
Summary: What it's useful for, how to use it, and how it interacts with C# classes

Requesting: Docs Page
Topic: Scene View
Summary: What appears in it. Further reading: How scenes work

Requesting: Docs Page
Topic: Prefabs
Summary: What is a prefab. What should prefabs be used for. How to use them

Requesting: Docs Page
Topic: Pixmaps, Textures, and Materials
Summary: Differences between each type, use cases for each

Requesting: Docs Page
Topic: RenderTarget
Summary: What is a RenderTarget. What to use them for. How to use them

Requesting: Docs Page
Topic: SpriteRenderer and AnimSpriteRenderer
Summary: Differences and use cases, how to use AnimSpriteRenderer

Requesting: Docs Page
Topic: RigidBody
Summary: What is a RigidBody. How to use them. How to achieve different physics effects with them

Requesting: Docs Page
Topic: Application Data
Summary: What it's used for. How to use it. How to use CustomData

Requesting: Docs Page
Topic: Default User Data
Summary: What it's used for. How to use it

Requesting: Docs Page
Topic: Package Manager
Summary: What it does. How to install packages. How to publish packages

Requesting: Docs Page
Topic: CorePlugin.cs
Summary: What it's used for. What you might typically put in it

Requesting: Docs Page
Topic: Scene View
Summary: Description of each tool on the toolbar. Description of Game/RigidBody/Scene views



EDIT: Where can I edit the documentation?


Top
 Profile  
 
PostPosted: 2016/10/16, 16:06 
Site Admin
Site Admin
User avatar

Joined: 2013/05/11, 22:30
Posts: 1935
Location: Germany
Role: Professional
I have created a new GitHub milestone specifically for easing the learning curve of Duality. If you have a more concrete idea on a specific topic, complete with a list of sub-topics to deal with, feel free to submit an issue to the tracker! We can also use these issues to keep track of each topic's progress, as well as discuss its article.

When submitting a new issue, please follow the overall structure that you can see in existing issues. Also keep in mind that each issue should be as self-contained and close-ended as reasonably possible.

So far, I've added a few issues for more advanced topics that came up recently which I'll probably deal with myself, but feel free to add your own ones too. If you plan on writing an article on an issue, please comment so it's clear that this one is blocked for the moment :)

_________________
Blog | GitHub | Twitter (@Adams_Lair)


Top
 Profile  
 
Display posts from previous:  Sort by  
Post new topic Reply to topic  [ 6 posts ] 

All times are UTC + 1 hour [ DST ]


Who is online

Users browsing this forum: No registered users and 1 guest


You cannot post new topics in this forum
You cannot reply to topics in this forum
You cannot edit your posts in this forum
You cannot delete your posts in this forum

Jump to:  
cron
Powered by phpBB® Forum Software © phpBB Group