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

Adds Learn segment with 4 main sections #34

Merged
merged 23 commits into from
May 26, 2023
Merged

Conversation

loonggamma
Copy link
Contributor

@loonggamma loonggamma commented May 16, 2023

The Learn section is an improvement of Massa's Architecture section.

Planned sections in order:

  1. Basic concepts (previous Introduction), which needs improvements in content. I instructed what needs to be done..
  2. Node Architecture (previous Architecture) which needs validation as I shortened some content where I could.
  3. Operation lifecycle (as it was, no need to fix it)
  4. Consensus quality initiatives - a new section for which I planned to include:
  • Endorsements (needs core validation as I shortened some parts and also needs their check since they made some changes to endorsements object)
  • Slashing (needs a full write up)
  • Node banning (needs a full write up). The idea with this new section is to unify all (dis)incentives in our consensus in one place where you can learn how we maximize the quality of our network.

All needed changes/needed content or checks I showed in Admonition :::danger

To do:

  • Validate my summaries and planned structure;
  • Add all diagrams and tables as indicated in the code;
  • Add equations using Katex for parts of the code in ``
  • Fill all links that currently don't exist.
  • Improve content specified in Admonitions -> danger mode -> done, creating separate issues to be tackled by Core team

@loonggamma loonggamma linked an issue May 16, 2023 that may be closed by this pull request
@loonggamma
Copy link
Contributor Author

loonggamma commented May 19, 2023

@gregLibert:

Content of Learn part is ready to be filled by intern for:

  • links
  • equations with Katex
  • Diagrams and images as marked with Admonition :::danger
  • reorganize the sidebar in case we go with 1 concept per page, like Block, Operation, etc.

Note: I created sections that need write up by Core team and marked with - to do, so they can navigate easier. Also lines have been broken for easier navigation in the docu.

docs/learn/architecture/consensus-quality.mdx Show resolved Hide resolved
docs/learn/architecture/consensus-quality.mdx Outdated Show resolved Hide resolved
docs/learn/architecture/consensus-quality.mdx Outdated Show resolved Hide resolved
docs/learn/architecture/consensus-quality.mdx Show resolved Hide resolved
docs/learn/architecture/operation-lifecycle.mdx Outdated Show resolved Hide resolved
docs/learn/architecture/operation-lifecycle.mdx Outdated Show resolved Hide resolved
docs/learn/architecture/operation-lifecycle.mdx Outdated Show resolved Hide resolved
docs/learn/architecture/operation-lifecycle.mdx Outdated Show resolved Hide resolved
@gregLibert
Copy link
Contributor

gregLibert commented May 22, 2023

@gregLibert:

Content of Learn part is ready to be filled by intern for:

  • links
  • equations with Katex
  • Diagrams and images as marked with Admonition :::danger
  • reorganize the sidebar in case we go with 1 concept per page, like Block, Operation, etc.

Note: I created sections that need write up by Core team and marked with - to do, so they can navigate easier. Also lines have been broken for easier navigation in the docu.

@windushka Can you please help us here ? feel free to poing @longgamma-massa or myself if you need some help!

loonggamma and others added 5 commits May 22, 2023 13:23
Co-authored-by: AurelienFT <32803821+AurelienFT@users.noreply.github.com>
Co-authored-by: AurelienFT <32803821+AurelienFT@users.noreply.github.com>
Co-authored-by: AurelienFT <32803821+AurelienFT@users.noreply.github.com>
Co-authored-by: AurelienFT <32803821+AurelienFT@users.noreply.github.com>
@loonggamma
Copy link
Contributor Author

@gregLibert applied changes to content instructed by Aurelien.

docs/learn/architecture/basic-concepts.mdx Outdated Show resolved Hide resolved
docs/learn/architecture/basic-concepts.mdx Outdated Show resolved Hide resolved
docs/learn/architecture/basic-concepts.mdx Outdated Show resolved Hide resolved
@windushka windushka requested a review from gregLibert May 24, 2023 07:10
@gregLibert
Copy link
Contributor

@longgamma-massa can I merge this branch ?

@loonggamma
Copy link
Contributor Author

@longgamma-massa can I merge this branch ?

@gregLibert @windushka

The links for JSON RPC and GRPC are incorrect in the 'architecture' file -> 'API module' section. They lead to providers list instead of to pages where JSON RPC and GRPC documentation will be hosted, not the list of providers.

They rest is good to be merged (note: there are still subsections in text marked as 'to do' for Core's further work (issues are crearted).

@gregLibert gregLibert mentioned this pull request May 26, 2023
@gregLibert gregLibert merged commit 8687463 into main May 26, 2023
@gregLibert gregLibert deleted the 31-learn-architecture branch May 26, 2023 15:42
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.

Learn - Architecture
4 participants