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 architecture part in the Whitepaper #237

Merged
merged 10 commits into from
Jun 23, 2023
Merged

Add architecture part in the Whitepaper #237

merged 10 commits into from
Jun 23, 2023

Conversation

antho31
Copy link
Contributor

@antho31 antho31 commented Jun 16, 2023

Here's the first version of the "Architecture" section of the whitepaper.

  • Overall architecture (updated schema since our meeting on June 14)
  • Mermaid sequence diagram from the end-to-end example

Note that texts and schemas have not been fully validated. There are some fuzzy points. It may be worth publishing this to help developers for the Builders Program...

What are your points?

@antho31 antho31 added the documentation Improvements or additions to documentation label Jun 16, 2023
@antho31 antho31 self-assigned this Jun 16, 2023
Copy link
Member

@ccamel ccamel left a comment

Choose a reason for hiding this comment

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

Great job. I left some comments. There are indeed some inaccuracies and uncertainties in some paragraphs that need to be addressed. We can have a meeting to discuss them together, with @amimart.

docs/whitepaper/architecture.mdx Outdated Show resolved Hide resolved
docs/whitepaper/architecture.mdx Outdated Show resolved Hide resolved
docs/whitepaper/architecture.mdx Outdated Show resolved Hide resolved
docs/whitepaper/architecture.mdx Outdated Show resolved Hide resolved
docs/whitepaper/architecture.mdx Outdated Show resolved Hide resolved
docs/whitepaper/architecture.mdx Outdated Show resolved Hide resolved
docs/whitepaper/architecture.mdx Outdated Show resolved Hide resolved
docs/whitepaper/architecture.mdx Outdated Show resolved Hide resolved
docs/whitepaper/architecture.mdx Outdated Show resolved Hide resolved
docs/whitepaper/architecture.mdx Outdated Show resolved Hide resolved
@antho31 antho31 requested a review from ccamel June 19, 2023 10:31
Copy link
Member

@amimart amimart left a comment

Choose a reason for hiding this comment

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

Thanks !

Here's a first review, I didn't check everything in details though :)

docs/whitepaper/architecture.mdx Outdated Show resolved Hide resolved
docs/whitepaper/architecture.mdx Show resolved Hide resolved
docs/whitepaper/architecture.mdx Show resolved Hide resolved
docs/whitepaper/architecture.mdx Outdated Show resolved Hide resolved
docs/whitepaper/architecture.mdx Outdated Show resolved Hide resolved
docs/whitepaper/architecture.mdx Outdated Show resolved Hide resolved
docs/whitepaper/architecture.mdx Outdated Show resolved Hide resolved
docs/whitepaper/architecture.mdx Outdated Show resolved Hide resolved
Copy link
Member

@MdechampG MdechampG left a comment

Choose a reason for hiding this comment

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

Thank you @antho31 ! Here are few typos.

docs/whitepaper/architecture.mdx Outdated Show resolved Hide resolved
docs/whitepaper/architecture.mdx Outdated Show resolved Hide resolved
docs/whitepaper/architecture.mdx Outdated Show resolved Hide resolved
docs/whitepaper/architecture.mdx Outdated Show resolved Hide resolved
@antho31
Copy link
Contributor Author

antho31 commented Jun 20, 2023

Thanks, @amimart & @MdechampG, for your complete and relevant feedback! The last commit integrates all the suggested changes, it includes updated schemas too.

@antho31
Copy link
Contributor Author

antho31 commented Jun 22, 2023

Updated with schemas from Lisa.
Can we publish this new part of the WP?

Co-authored-by: Chris <camel.christophe@gmail.com>
@antho31 antho31 requested a review from ccamel June 23, 2023 09:41
@antho31 antho31 merged commit be85cd5 into main Jun 23, 2023
@antho31 antho31 deleted the feat/wp-archi branch June 23, 2023 11:54
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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants