Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

The PMH Book and User Manual #329

Open
5 tasks
James-Oswald opened this issue Dec 16, 2023 · 1 comment
Open
5 tasks

The PMH Book and User Manual #329

James-Oswald opened this issue Dec 16, 2023 · 1 comment
Assignees
Labels
documentation Improvements or additions to documentation Major Feature Takes a lot of work to implement No API-Break Will not break test results or backwards compatibility. Middle number in semantic versioning

Comments

@James-Oswald
Copy link
Member

Pictures of the UI portion of the application (not including the canvas) should not be included in the manual until after the UI Overhaul outlined in issue #318. Until then it is sufficient to describe what the application does, what AEGs are, and what all the different modes do via pictures of causes and effects from the canvas.

The book should be done in markdown. It will be built into a book using mdBook which is what the official rust and lean eBooks use.

Some important sections:

  • Chapter 1 Introduction to logic via AEGs
  • Contrary to the approach i take in my blog post, do not assume the user knows PC, introduce logic from first principals using AEGs.
  • Chapter 2 Propositional Calculus and its relation to AEGs
  • Talk about PC and how we may convert between it and AEGs for those who know propositional calculus.
  • Chapter 3 Introduce PMH and our features.
    • AEG construction in draw mode.
    • AEG theorem proving in proof mode.
@James-Oswald James-Oswald added documentation Improvements or additions to documentation Enhancement New feature Major Feature Takes a lot of work to implement labels Dec 16, 2023
@James-Oswald James-Oswald modified the milestone: PMH 2.0.0 Dec 16, 2023
@James-Oswald James-Oswald removed the Enhancement New feature label Dec 16, 2023
@RyanR712 RyanR712 self-assigned this Dec 16, 2023
@James-Oswald James-Oswald self-assigned this Dec 16, 2023
@RyanR712
Copy link
Collaborator

We have a different repository for the book up and running, since mdbook involves Cargo, a different package manager. Check it out!

https://github.com/RAIRLab/EG-Theorem-Proving-in-PMH

@RyanR712 RyanR712 added the No API-Break Will not break test results or backwards compatibility. Middle number in semantic versioning label Jan 3, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation Major Feature Takes a lot of work to implement No API-Break Will not break test results or backwards compatibility. Middle number in semantic versioning
Projects
None yet
Development

No branches or pull requests

2 participants