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

Add documentation #4

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add documentation #4

wants to merge 1 commit into from

Conversation

nezaniel
Copy link
Member

No description provided.

@nezaniel nezaniel requested a review from grebaldi April 15, 2021 15:55
Copy link
Contributor

@grebaldi grebaldi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I added some minor suggestions, but other than those the documentation looks great!

@@ -0,0 +1,3 @@
1. [User Interface](./Documentation/01_UserInterface.md)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
1. [User Interface](./Documentation/01_UserInterface.md)
1. [User Interface](./01_UserInterface.md)

@@ -0,0 +1,3 @@
1. [User Interface](./Documentation/01_UserInterface.md)
2. [Building Blocks: Objects, Agents and Tasks](./Documentation/02_BuildingBlocks.md)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
2. [Building Blocks: Objects, Agents and Tasks](./Documentation/02_BuildingBlocks.md)
2. [Building Blocks: Objects, Agents and Tasks](./02_BuildingBlocks.md)

@@ -0,0 +1,3 @@
1. [User Interface](./Documentation/01_UserInterface.md)
2. [Building Blocks: Objects, Agents and Tasks](./Documentation/02_BuildingBlocks.md)
2. [Writing Custom Tasks](./Documentation/03_CustomTasks.md)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
2. [Writing Custom Tasks](./Documentation/03_CustomTasks.md)
2. [Writing Custom Tasks](./03_CustomTasks.md)


![Screenshot of task reminder](screenshot.png)

The most important function of PresentationObjects is to enforce the interface between domain and presentation layer.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
The most important function of PresentationObjects is to enforce the interface between domain and presentation layer.


The most important function of PresentationObjects is to enforce the interface between domain and presentation layer.

For a single component that interface is represented by an actual PHP interface. So let's start with that:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
For a single component that interface is represented by an actual PHP interface. So let's start with that:

---

<div align="center">
<a href="./02_BuildingBlocks.md">< 2. Building Blocks &gt;</a>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
<a href="./02_BuildingBlocks.md">< 2. Building Blocks &gt;</a>
<a href="./02_BuildingBlocks.md">&lt; 2. Building Blocks</a>

@@ -0,0 +1,60 @@
<div align="center">
<a href="./02_BuildingBlocks.md">< 2. Building Blocks &gt;</a>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
<a href="./02_BuildingBlocks.md">< 2. Building Blocks &gt;</a>
<a href="./02_BuildingBlocks.md">&lt; 2. Building Blocks</a>

---

<div align="center">
<a href="./01_UserInterface.md">< 1. User Interface</a>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
<a href="./01_UserInterface.md">< 1. User Interface</a>
<a href="./01_UserInterface.md">&lt; 1. User Interface</a>

@@ -0,0 +1,67 @@
<div align="center">
<a href="./01_UserInterface.md">< 1. User Interface</a>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
<a href="./01_UserInterface.md">< 1. User Interface</a>
<a href="./01_UserInterface.md">&lt; 1. User Interface</a>

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants