Tasks #781

Create a manual

Added by J. Moringen almost 10 years ago. Updated over 9 years ago.

Status:ResolvedStart date:12/22/2011
Priority:NormalDue date:
Assignee:J. Moringen% Done:

100%

Category:-
Target version:Robotics Service Bus - 0.6

Related issues

Related to Robotics Service Bus - Tasks #900: Finalize initial version of RSB manual Resolved 07/13/2012

Associated revisions

Revision 30f0c3f6
Added by J. Moringen over 9 years ago

Extended binary installation instructions in manual/installation.rst
refs #781
  • manual/installation.rst: mention project version some more; describe
    symlink structure

Revision 30ceba37
Added by J. Moringen over 9 years ago

Mention partial Elan support in manual/index.rst
refs #781
  • manual/conf.py.in: added Elan link
  • manual/index.rst: mention partial support for the Elan XML file
    format

History

#1 Updated by J. Moringen over 9 years ago

  • Status changed from New to In Progress
  • % Done changed from 0 to 50

#2 Updated by S. Wrede over 9 years ago

Great! Good start. Will you reference this already from the Redmine project and the toolkit catalogue entry?

Along the same lines: Did you already remove parts of the Wiki content in favor of the new documentation?

#3 Updated by J. Moringen over 9 years ago

Sebastian Wrede wrote:

Great! Good start. Will you reference this already from the Redmine project and the toolkit catalogue entry?

I think there is no documentation node type, yet. flier should know ...

Along the same lines: Did you already remove parts of the Wiki content in favor of the new documentation?

No, just copied stuff and wrote from scratch so far.

#4 Updated by J. Moringen over 9 years ago

  • Assignee set to J. Moringen
  • Target version set to 0.6
  • % Done changed from 50 to 70

#5 Updated by J. Moringen over 9 years ago

An initial version is written.

Open issues:
  • We still have to discuss whether the chosen structure makes sense
  • The manual probably needs testing

#6 Updated by S. Wrede over 9 years ago

I suppose it is already much better than the wiki pages. So, my main comment at this stage is to remove the redundant information from the wiki pages and add a reference to the new documentation as part of the 0.6 release efforts. Through this change and the coming system developments in HUMAVIPS and SozIRob we may also get quite early feedback. Furthermore, we may consider to present the envisioned dataset talk for the RSB meeting also in the AI club.

#7 Updated by J. Wienke over 9 years ago

  • Status changed from In Progress to Resolved
  • % Done changed from 70 to 100

The task of "creation" has been done. Further issues will be tracked with #900.

As long as the manual is not fully evaluated we propose to leave the wiki alive as it is.

Also available in: Atom PDF