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

refresh guardians page, update llms #313

Merged
merged 25 commits into from
Mar 25, 2025
Merged

Conversation

dawnkelly09
Copy link
Collaborator

Description

Reformats some sections for readability, tone, etc. adds Where to Go Next cards, updates llms

Checklist

  • [ x] Required - I have added a label to this PR 🏷️
  • [x ] Required - I have run my changes through Grammarly
  • [ n/a] If pages have been moved, I have created redirects in the wormhole-mkdocs repo

eshaben and others added 18 commits February 19, 2025 00:36
* add settlement to learn section

* add settlement to buil section

* fix links

* liquidity layer code snippets

* solver snippets

* llms

---------

Co-authored-by: Ilaria Enache <ilaria@Host-009.homenet.telecomitalia.it>
* adds connect index page to new IA

* tweaks admonition usage on /docs/build/transfers/connect/overview/

* moves timeline into snippet, left aligned

* feedback per review

* llms

* edits per feedback

* improve intro

* edits per feedback

* applies review feedback

* Apply suggestions from code review

Co-authored-by: Erin Shaben <eshaben@icloud.com>

---------

Co-authored-by: Erin Shaben <eshaben@icloud.com>
* adds token bridge build page in the new ai and fixes links

* Update build/transfers/token-bridge.md

Co-authored-by: Lucas Malizia <131050418+0xlukem@users.noreply.github.com>

* Update build/transfers/token-bridge.md

Co-authored-by: Lucas Malizia <131050418+0xlukem@users.noreply.github.com>

---------

Co-authored-by: Ilaria Enache <ilaria@Host-009.homenet.telecomitalia.it>
Co-authored-by: Lucas Malizia <131050418+0xlukem@users.noreply.github.com>
* settlement faq

* typo fix

* Update build/transfers/settlement/faqs.md

Co-authored-by: Lucas Malizia <131050418+0xlukem@users.noreply.github.com>

* Update build/transfers/settlement/faqs.md

Co-authored-by: Lucas Malizia <131050418+0xlukem@users.noreply.github.com>

* quick fix

* fix

* Update build/transfers/settlement/.pages

Co-authored-by: Erin Shaben <eshaben@icloud.com>

* typo fix

* Update build/transfers/settlement/.pages

Co-authored-by: Lucas Malizia <131050418+0xlukem@users.noreply.github.com>

* apply feedback and llms

---------

Co-authored-by: Ilaria Enache <ilaria@Host-009.homenet.telecomitalia.it>
Co-authored-by: Lucas Malizia <131050418+0xlukem@users.noreply.github.com>
Co-authored-by: Ilaria Enache <ilaria@Host-006.homenet.telecomitalia.it>
Co-authored-by: Erin Shaben <eshaben@icloud.com>
* adds build/core-messaging/index page

* grammarly and llms

* Apply suggestions from code review

Co-authored-by: Erin Shaben <eshaben@icloud.com>

* change cross-chain to multichain, update llms

* combine timelines into one

* corrects timeline syntax, updates llms

---------

Co-authored-by: Erin Shaben <eshaben@icloud.com>
Co-authored-by: Ilaria Enache <ilaria@Host-006.homenet.telecomitalia.it>
* adds connect index page to new IA

* tweaks admonition usage on /docs/build/transfers/connect/overview/

* moves timeline into snippet, left aligned

* feedback per review

* llms

* edits per feedback

* improve intro

* edits per feedback

* adds build/transfers/index page

* llms

* updates per review feedback

* llms

* change cross-chain to multichain, update llms

* updates llms

* Apply suggestions from code review

Co-authored-by: Erin Shaben <eshaben@icloud.com>

* adds back supported feature card per feedback, updates llms

* Update build/transfers/index.md

Co-authored-by: Erin Shaben <eshaben@icloud.com>

* Update build/transfers/index.md

Co-authored-by: Erin Shaben <eshaben@icloud.com>

* Update build/transfers/index.md

Co-authored-by: Erin Shaben <eshaben@icloud.com>

---------

Co-authored-by: Erin Shaben <eshaben@icloud.com>
Co-authored-by: Ilaria <43253244+ilariae@users.noreply.github.com>
Co-authored-by: Ilaria Enache <ilaria@Host-006.homenet.telecomitalia.it>
* adds connect index page to new IA

* tweaks admonition usage on /docs/build/transfers/connect/overview/

* moves timeline into snippet, left aligned

* feedback per review

* llms

* edits per feedback

* improve intro

* edits per feedback

* applies review feedback

* updates learn/infra index page

* moves spy to timeline, removes additional resources

* removes spy from timeline, adds next steps section

* small edit, llms

* Update learn/infrastructure/index.md

Co-authored-by: Erin Shaben <eshaben@icloud.com>

* Update .snippets/text/learn/infrastructure/infrastructure-index-timeline.json

Co-authored-by: Erin Shaben <eshaben@icloud.com>

---------

Co-authored-by: Ilaria <43253244+ilariae@users.noreply.github.com>
Co-authored-by: Erin Shaben <eshaben@icloud.com>
Co-authored-by: Ilaria Enache <ilaria@Host-006.homenet.telecomitalia.it>
* adds connect index page to new IA

* tweaks admonition usage on /docs/build/transfers/connect/overview/

* moves timeline into snippet, left aligned

* feedback per review

* llms

* edits per feedback

* improve intro

* edits per feedback

* applies review feedback

* updates learn/infra index page

* updates learn/transfers/index page

* Delete .snippets/text/build/transfers/connect/connect-timeline.json

not needed in this PR

* Delete build/transfers/connect/index.md

* add placeholder connect index page

* updates links on cards

* moves spy to timeline, removes additional resources

* removes spy from timeline, adds next steps section

* change cross-chain to multichain, update llms

* removes use case based copy, adds comparison NTT & TB, has TODOs

* settlement section and ntt vs token bridge

* applies updates from review feedback, updates llms

* removes settlement table, displays NTTvsTB table, adds YT video embed, updates llms

* Delete learn/infrastructure/index.md

* small edit, llms

* Update learn/infrastructure/index.md

Co-authored-by: Erin Shaben <eshaben@icloud.com>

* Update .snippets/text/learn/infrastructure/infrastructure-index-timeline.json

Co-authored-by: Erin Shaben <eshaben@icloud.com>

* Update learn/transfers/index.md

Co-authored-by: Erin Shaben <eshaben@icloud.com>

* Update learn/transfers/index.md

Co-authored-by: Erin Shaben <eshaben@icloud.com>

* Update learn/transfers/index.md

Co-authored-by: Erin Shaben <eshaben@icloud.com>

---------

Co-authored-by: Ilaria Enache <ilaria@Host-006.homenet.telecomitalia.it>
Co-authored-by: Ilaria <43253244+ilariae@users.noreply.github.com>
Co-authored-by: Erin Shaben <eshaben@icloud.com>
* adds new content for build/index page

* moves timeline to snippets

* converts timeline to cards per feedback

* adds sections for multigov & queries, updates cross-chain to multichain, updates llms

* updates from review feedback, updates llms

* Update build/index.md

Co-authored-by: Erin Shaben <eshaben@icloud.com>

* Update build/index.md

---------

Co-authored-by: Ilaria <43253244+ilariae@users.noreply.github.com>
Co-authored-by: Erin Shaben <eshaben@icloud.com>
Co-authored-by: Ilaria Enache <ilaria@Host-006.homenet.telecomitalia.it>
* adds connect index page to new IA

* tweaks admonition usage on /docs/build/transfers/connect/overview/

* moves timeline into snippet, left aligned

* feedback per review

* llms

* edits per feedback

* improve intro

* edits per feedback

* applies review feedback

* starts learn index page

* removes placeholder

* updates

* learn/index page updates

* adds settlement section, replaces cross-chain with multichain, updates LLMs

* applies review feedback, updates llms

* Update learn/index.md

---------

Co-authored-by: Ilaria <43253244+ilariae@users.noreply.github.com>
Co-authored-by: Ilaria Enache <ilaria@Host-006.homenet.telecomitalia.it>
* Split contract integration faqs to new pages (#300)

* split out FAQs from contract integrations section

* add links

* llm check

---------

Co-authored-by: martin0995 <martin@papermoon.io>

* update consistency level references (#299)

* update consistency level references

* fix link

* fix link

* remove duplicate text

* updates for consistency

* llm check

---------

Co-authored-by: Martin Hofmann <martin@papermoon.io>

* update link

* llm check

---------

Co-authored-by: Erin Shaben <eshaben@icloud.com>
Co-authored-by: Ilaria Enache <ilaria@Host-006.homenet.telecomitalia.it>
Co-authored-by: Ilaria Enache <ilaria@Host-006.homenet.telecomitalia.it>
* update tables with new sdk version

* llm check
@dawnkelly09 dawnkelly09 added A1 - Maintenance Major Pull request contains major updates to an existing page (i.e., adding a new section, reorgs, etc.) B0 - Needs Review Pull request is ready for review labels Mar 19, 2025
@dawnkelly09 dawnkelly09 requested a review from eshaben as a code owner March 19, 2025 17:43
Copy link
Collaborator

@eshaben eshaben left a comment

Choose a reason for hiding this comment

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

Thanks!

@ilariae @martin0995 lots of content was removed, please check this out and make sure it looks good! Thanks!

Copy link
Collaborator

@ilariae ilariae left a comment

Choose a reason for hiding this comment

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

i think too much important context was cut, I see this page as the one explaining the philosophy behind wormhole and why things were made in the way they are. Especially the decentralization section I don't like it we should bring back the ancient texts.
For the sake of simplicity too much was cut and I feel like we lost value. Maybe not many people go and read this page but the ones who do need to see the full context.
So what I propose
At the beginning of the page we say guardians do this and that for the users that just want to have a quick read to understand what guardians actually do
but the story of the whys should remain complete
Modularity, chain agnosticism, scalability and upgradability sections I think are okay simplified like this there wasn't much there anyway, but bring the decentralization content back

@dawnkelly09 dawnkelly09 requested a review from eshaben March 24, 2025 14:31
@dawnkelly09 dawnkelly09 requested review from ilariae and removed request for martin0995 March 24, 2025 14:31
eshaben
eshaben previously approved these changes Mar 24, 2025
Copy link
Collaborator

@eshaben eshaben left a comment

Choose a reason for hiding this comment

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

LGTM

@eshaben eshaben added B1 - Ready to Merge Pull request is ready to be merged and removed B0 - Needs Review Pull request is ready for review labels Mar 24, 2025
ilariae
ilariae previously approved these changes Mar 24, 2025
Copy link
Collaborator

@ilariae ilariae left a comment

Choose a reason for hiding this comment

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

LGTM

@ilariae ilariae changed the base branch from new-product-ia to main March 24, 2025 18:41
@ilariae ilariae dismissed stale reviews from eshaben and themself March 24, 2025 18:41

The base branch was changed.

@ilariae ilariae removed the B1 - Ready to Merge Pull request is ready to be merged label Mar 24, 2025
@dawnkelly09 dawnkelly09 requested review from eshaben and ilariae March 25, 2025 14:19
@dawnkelly09 dawnkelly09 added the B0 - Needs Review Pull request is ready for review label Mar 25, 2025
@eshaben eshaben added B1 - Ready to Merge Pull request is ready to be merged and removed B0 - Needs Review Pull request is ready for review labels Mar 25, 2025
@martin0995 martin0995 merged commit 4d6740d into main Mar 25, 2025
2 checks passed
@martin0995 martin0995 deleted the dawn/polish-guardian-page branch March 25, 2025 16:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A1 - Maintenance Major Pull request contains major updates to an existing page (i.e., adding a new section, reorgs, etc.) B1 - Ready to Merge Pull request is ready to be merged
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants