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

docs: Adding the introduction to the Request Protocol #172

Merged
merged 3 commits into from
Mar 17, 2020

Conversation

lumtis
Copy link
Contributor

@lumtis lumtis commented Mar 13, 2020

Description of the changes

Adding the page "Introduction to the Request Protocol" to the documentation

Copy link
Member

@yomarion yomarion left a comment

Choose a reason for hiding this comment

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

I propose to split the page into smaller ones, for example:

  • Overview
  • (1 page per layer)
  • Data flow

Copy link
Contributor

@vrolland vrolland left a comment

Choose a reason for hiding this comment

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

I agree with @yomarion. the introduction should be very short and the rest must be split.

I would make the draw more clear. It is difficult to do so through github, I am up for a call about this. @ltacker

To organize these different purposes, the Request Protocol follows the layered architecture pattern. Each layer is responsible for a specific task and a specific level of abstraction. This layered architecture also simplifies the understandability of the code, we believe it's an important matter for an open-source project.

The protocol is composed of four layers:
- Request logic
Copy link
Contributor

Choose a reason for hiding this comment

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

missing ̀advanced logic`

Copy link
Contributor Author

Choose a reason for hiding this comment

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

As I already stated on Notion, advanced logic is not a layer in the Layered Architecture Pattern point of viewx

@lumtis
Copy link
Contributor Author

lumtis commented Mar 16, 2020

I agree with @yomarion. the introduction should be very short and the rest must be split.

I would make the draw more clear. It is difficult to do so through github, I am up for a call about this. @ltacke

We can discuss tomorrow 👍but I think it's already a version pushable, if there are optimization to make we can push them after the doc is released

@lumtis lumtis merged commit 86dfd04 into docs-with-sidebar Mar 17, 2020
@lumtis lumtis deleted the docs-protocol-page branch March 17, 2020 02:06
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.

None yet

3 participants