ubc-carnap-team / Rudolf

Truth Tree Widget for Carnap
2 stars 3 forks source link

Document the UI #48

Closed McTano closed 4 years ago

McTano commented 4 years ago

It would be good if we had documentation on how to use the widget.

As a first stage maybe just an explanation of the controls, and the difference between "nodes" and "formulas/rows".

It would be nice if the user didn't have to think about that distinction, but at the moment we're stuck with it, so it would be good to describe it.

In the future, we could also add an explanation of how to type the various logic symbols, although maybe that should live at the FiraLogic repo.

orbit-stabilizer commented 4 years ago

As someone new to the project and someone who doesn't really know the difference between nodes or formulas/rows, I could review the documentation and see how helpful it is.

kylemas commented 4 years ago

Definitely!

@McTano I can work on this as well.

McTano commented 4 years ago

Yeah. It's undocumented except for instant message conversations, at this point.

On Sun, May 24, 2020, 9:41 PM Kyle Mas notifications@github.com wrote:

Definitely!

@McTano https://github.com/McTano I can work on this as well.

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/McTano/Rudolf/issues/48#issuecomment-633372678, or unsubscribe https://github.com/notifications/unsubscribe-auth/AEFHH6RPTTAQ5IMRGU6XR5LRTHZIHANCNFSM4NIU473Q .

orbit-stabilizer commented 4 years ago

I took a look at the Wiki and it's super readable to me - especially with the images!

McTano commented 4 years ago

Great, I'll close this.