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

DRAFT:CDK - Add pp intro doc #2460

Draft
wants to merge 6 commits into
base: main
Choose a base branch
from
Draft

Conversation

EmpieichO
Copy link
Contributor

DRAFT:CDK - Add pp intro + components descriptions doc

@mitchpolygon
Copy link

Hello Anthony! Below you will find changes to the PP docs:

  1. Can we make the "AggLayer-side components" a subheading to "Component descriptions"? They shouldn't be on the same level of hierarchy IMO because they are still considered a component description.
    1b. I believe there is a spelling error "Here are brief descriptions for each CDK FEP component" Should be "Here are brief descriptions for each CDK PP component."
Changes-1-Mitch
  1. Update the "See the high level view of the CDK PP chain architecture here" link under "AggLayer-side components" to go to the PP chain architecture diagram (currently goes to CDK FEP diagram).
Changes-2-Mitch

Copy link

sonarcloud bot commented Oct 25, 2024

@EmpieichO
Copy link
Contributor Author

Hi @mitchpolygon. Thanks for the suggestions.

  1. The heading is now adjusted.

  2. The link was intentionally and temporarily incorrect because these PRs are separate and their commits are not yet merged. Except for the Review Env of course, so I have corrected it in there.
    ... I will do the same on the actual PR only when finalising the docs for PROD.

@vcastellm vcastellm marked this pull request as draft October 30, 2024 17:40
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.

3 participants