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

Builders reorg #889

Merged
merged 65 commits into from
Apr 30, 2024
Merged

Builders reorg #889

merged 65 commits into from
Apr 30, 2024

Conversation

eshaben
Copy link
Contributor

@eshaben eshaben commented Mar 15, 2024

Description

This PR is built on-top of the Moonbeam vs Ethereum changes PR as a way to hopefully make the review process a bit easier: #888

This PR adds a page on creating an account, moves the Eth JSON RPC and Moonbeam JSON RPC content to the "Interact with the Network" section (name subject to change), and also renames some of the other sections in the Builders section.

Section index page icons are here: papermoonio/moonbeam-mkdocs#181
⚠️ will need to update the mkdocs PR to include redirects

Checklist

  • I have added a label to this PR 🏷️
  • I have run my changes through Grammarly
  • If this requires translations for the moonbeam-docs-cn repo, I have created a ticket for the translations in Jira
  • If pages have been moved around, I have created an additional PR in moonbeam-mkdocs to update redirects

Corresponding PRs

Please link to any corresponding PRs here.

After Translation Requirements

  • Will need to create PR in moonbeam-mkdocs repo to add redirects for Chinese site

- rename a few sections
- move the ethereum rpc and moonbeam api to the protocol functionality section
- add a page on creating an account to the get started section
@eshaben eshaben changed the title Eshaben/reorg builders Builders reorg Mar 15, 2024
@eshaben eshaben added A0 - New Content Pull request contains new content pages A1 - Maintenance Major Pull request contains major updates to an existing page (i.e., adding a new section, reorgs, etc.) labels Mar 15, 2024
@eshaben
Copy link
Contributor Author

eshaben commented Mar 15, 2024

Maybe need to consider whether the Debug and Trace and Event Subscription pages should be moved

Copy link
Contributor

@albertov19 albertov19 left a comment

Choose a reason for hiding this comment

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

Hey! General notes:

  1. I believe the trace should be moved to Interact because tracing is actually a new JSON RPC spec
  2. The Interact With Network logo in the dropdown should change
  3. What about having a Dropdown for "JSON RPC API" and then have three separate things " Standard Ethereum", "Tracing Ethereum", "Custom Moonbeam" or something like that?
  4. One thing that is Weird in Development Toolkit is that it feels empty. Maybe we can create a "Ghost" section of Cross-Chain that points to places in the Interoperability docs?
  5. I feel that with our new structure, the left hand side menus loop a bit empty. Maybe (just an idea) we can have, in each section, a Tutorials section where we show how to use relevant stuff of that section? Wdyt? This would mean we scrap the tutorial section that currently exist.

Copy link
Contributor

@themacexpert themacexpert left a comment

Choose a reason for hiding this comment

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

LGTM 👍 just a couple quick things

learn/platform/technology.md Outdated Show resolved Hide resolved
builders/build/.pages Outdated Show resolved Hide resolved
Copy link
Contributor

@albertov19 albertov19 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 this looks good.

I left some comments and suggestions, let me know what you think!

@@ -1,4 +1,4 @@
title: Pallets & Precompiles
title: Interact with the Network
Copy link
Contributor

Choose a reason for hiding this comment

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

I'm not fond of this title because it looks weird in the dropdown menu:
image

Like a development toolkit, it also works to interact with the network, the same as for JSON RPC stuff.
I think this title has to answer the question "How will developers click here? What are they looking for?"

We should do some brainstorming around this

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yeah, would love some suggestions 🙂

Copy link
Contributor

Choose a reason for hiding this comment

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

Ok so maybe we can do something like "Unique Features"? And actually segment a bit more the precompile section so that there are multiple subsections like:

"
Precompiles:
|- Native Ethereum
|- User Experience
|- Interoperability
|- Network Features

"

Maybe not "Unique Features" but something like that?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

What about "Development Interfaces" - I actually really like this, feel like I finally found something I feel good about.

As for breaking up the precompiles section, I feel like this is opening another can of worms. But tried to come up with a couple of suggestions:

OPTION 1 (driving factor behind this option: I feel like certain precompiles should have higher visibility, this grouping makes it easier to understand there are several precompiles involved throughout the governance process, etc.):

Account Management
├─ Identity
└─ Proxy
Author Mapping
Ethereum Compatibility
├─ Ethereum MainNet
└─ ERC-20
Governance
├─ Collective
├─ Conviction Voting
├─ Preimage
└─ Referenda
Interoperability
├─ GMP
├─ X-Tokens
├─ XCM Transactor
└─ XCM Utilities
Staking
Randomness
User Experience
├─ Batch
└─ Call Permit
Utilities
├─ Precompile Registry
└─ Relay Data Verifier

OPTION 2 (driving factor: to categorize the precompiles so they are easier to find, however, there are more clicks for certain items and less visibility, but perhaps slightly more organized than option 1):

Ethereum Compatibility
├─ Ethereum MainNet
└─ ERC-20
User Experience
├─ Batch
└─ Call Permit
Utilities
├─ Author Mapping
├─ Precompile Registry
└─ Relay Data Verifier
Network Features
├─ Governance
│   ├─ Collective
│   ├─ Conviction Voting
│   ├─ Preimage
│   └─ Referenda
├─ Identity
├─ Interoperability
│   ├─ GMP
│   ├─ X-Tokens
│   ├─ XCM Transactor
│   └─ XCM Utilities
├─ Proxy
├─ Staking
└─ Randomness

I prefer the first option, as it adds some organization making certain precompiles easier to find and it also maintains visibility of the precompiles (not having items too nested), but it could maybe benefit from some changes; what those changes might be is what I am unsure about

builders/pallets-precompiles/pallets/.pages Show resolved Hide resolved
@@ -1,4 +1,4 @@
title: Pallets
title: Substrate API
Copy link
Contributor

Choose a reason for hiding this comment

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

I do like this new title, but it feels weir that we don't have an "Ethereum API".

So maybe by changing the "Interact with the Network" title to something more relevant like "Unique Interfaces" or IDK we can just have "Ethereum API" and "Substrate API" (With Ethereum coming first?)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yeah, I get what you're saying. I think there is value in keeping "Precompiled Contracts" though - what about "Substrate Interfaces" or "Substrate Module Interfaces"?

Copy link
Contributor

@albertov19 albertov19 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 merged commit aa237e0 into eshaben/moonbeam-vs-eth Apr 30, 2024
@eshaben eshaben deleted the eshaben/reorg-builders branch April 30, 2024 19:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A0 - New Content Pull request contains new content pages A1 - Maintenance Major Pull request contains major updates to an existing page (i.e., adding a new section, reorgs, etc.)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants