OpenPsi missing documentation

[linas]

Per discussion in #3032

The openpsi README.md describes a version of openpsi that no longer exists. It's inaccurate in 120 different ways ... I recognize it, as something that I wrote long ago. As far as I know, there is no adequate documentation for openpsi that

-- explains what it is
-- explains how it works; this includes a review of all of the major components, including control, demand, action-selection.
-- explains the kinds of problems that it solves
-- illustrates how to use it.

In particular, the use of openpsi should be contrasted to the use of URE, as both of these solve similar problems, but in different ways.

-- it is not clear if dynamics is actually required to make openpsi work, or if that can be moved to it's own, unrelated directory. If dyanmics is not required for openpsi, then it should be moved to its own directory.

[amebel]

ok will update it

[linas]

Please, thanks, I can't overstate how important this is. In a certain sense, its more important than the code.

[stellarspot]

The openpsi README.md also has description:
OpenPsi examples

• The examples here are currently broken.

The openpsi examples needs to be updated as well.

[ferrouswheel]

There have been a number of updates to the OpenPsi README since this issue was opened, including answering some of the questions posed by Linas.

I'm all for improving the documentation further, but open-ended tasks tend to never be completed - so it may be worth closing this. Although perhaps we should require that the OpenPsi examples actually work!

I have done some very minor tidying in PR #3546

Edit: reading the linked issue, and reviewing the dates of the commits vs issues, casts doubt for me as to what state the OpenPsi documentation is in.

[linas]

true about "open-ended issues never close." But there are some semi-specific topics, and perhaps 2-3-4 people should read the docs, try to run the examples, pose questions as they come up. Yes, everyone is busy, but lack of good docs has been a blocker for bringing newcomers on-board.