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

Revamp ThirdWeb Docs #942

Merged
merged 85 commits into from
Aug 13, 2024
Merged

Revamp ThirdWeb Docs #942

merged 85 commits into from
Aug 13, 2024

Conversation

themacexpert
Copy link
Contributor

@themacexpert themacexpert commented Jun 13, 2024

Description

Freshens up ThirdWeb Docs.

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
  • If pages have been moved around, I have run the move-pages.py script to move the pages and update the image paths on the chinese repo
    • After the script has been run, I have created an additional PR in moonbeam-docs-cn
  • If images have been added, I have run the compress-images.py script to compress the images.
  • If variables (in variables.yml) need to be updated (such as a name change), I have updated the moonbeam-docs-cn repo to use the new variables
  • If this page requires a disclaimer, I have added one

Corresponding PRs

Please link to any corresponding PRs here.

After Translation Requirements

  • Will need to create PR in moonbeam-docs repo to remove images
  • Will need to create PR in moonbeam-docs repo to remove variables
  • Will need to create PR in moonbeam-mkdocs repo to add redirects for Chinese site
  • No additional PRs are required after the translations are done

Items to be Updated

Please list any of the items that will need to be added or deleted after the translations are done here.

@themacexpert themacexpert added the A1 - Maintenance Major Pull request contains major updates to an existing page (i.e., adding a new section, reorgs, etc.) label Jun 13, 2024
Copy link
Contributor

@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.

Nice! Thank you!

A couple things: can we use v5? I started to create a project and noticed that thirdweb v5 is used, but we're still using v4 links

It'd be nice to implement the title feature for code snippets. So like, ```js title="src/main.tsx"

builders/ethereum/dev-env/thirdweb.md Outdated Show resolved Hide resolved
builders/ethereum/dev-env/thirdweb.md Outdated Show resolved Hide resolved
builders/ethereum/dev-env/thirdweb.md Outdated Show resolved Hide resolved
builders/ethereum/dev-env/thirdweb.md Outdated Show resolved Hide resolved
builders/ethereum/dev-env/thirdweb.md Outdated Show resolved Hide resolved
builders/ethereum/dev-env/thirdweb.md Outdated Show resolved Hide resolved
builders/ethereum/dev-env/thirdweb.md Outdated Show resolved Hide resolved
builders/ethereum/dev-env/thirdweb.md Show resolved Hide resolved
builders/ethereum/dev-env/thirdweb.md Outdated Show resolved Hide resolved
themacexpert and others added 9 commits June 17, 2024 14:11
Co-authored-by: Erin Shaben <eshaben@icloud.com>
Co-authored-by: Erin Shaben <eshaben@icloud.com>
Co-authored-by: Erin Shaben <eshaben@icloud.com>
Co-authored-by: Erin Shaben <eshaben@icloud.com>
Copy link
Contributor

@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.

This is a bit more than just changing the links. We really need to make sure the code is using v5

builders/ethereum/dev-env/thirdweb.md Outdated Show resolved Hide resolved
builders/ethereum/dev-env/thirdweb.md Outdated Show resolved Hide resolved
builders/ethereum/dev-env/thirdweb.md Outdated Show resolved Hide resolved
builders/ethereum/dev-env/thirdweb.md Outdated Show resolved Hide resolved
builders/ethereum/dev-env/thirdweb.md Outdated Show resolved Hide resolved
Copy link
Contributor

@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.

I'm so sorry this turned out to be a much bigger task than I anticipated!! But thank you!! 🙌

I think following all of the steps in the interact with your contract section get a bit confusing. We're given an App.tsx file with the template and then you just start adding stuff to it, so maybe first start off by saying you can remove the template code. For all of the code snippets, I think we can break those inso steps like 1. import this 2. add this code and then build on top of the previous sections by using the ??? "view the complete App.tsx file" as you go. You can do a trick with the snippets so you only need to have one snippet and just grab the lines you need to reference. There is an example here: https://github.com/moonbeam-foundation/moonbeam-docs/blob/master/tutorials/integrations/supra.md?plain=1#L122-L207

lmk if you have any questions!

.snippets/code/builders/ethereum/dev-env/thirdweb/App.tsx Outdated Show resolved Hide resolved
builders/ethereum/dev-env/thirdweb.md Outdated Show resolved Hide resolved
builders/ethereum/dev-env/thirdweb.md Outdated Show resolved Hide resolved
builders/ethereum/dev-env/thirdweb.md Outdated Show resolved Hide resolved
builders/ethereum/dev-env/thirdweb.md Outdated Show resolved Hide resolved
builders/ethereum/dev-env/thirdweb.md Outdated Show resolved Hide resolved
builders/ethereum/dev-env/thirdweb.md Outdated Show resolved Hide resolved
builders/ethereum/dev-env/thirdweb.md Outdated Show resolved Hide resolved
builders/ethereum/dev-env/thirdweb.md Outdated Show resolved Hide resolved
builders/ethereum/dev-env/thirdweb.md Outdated Show resolved Hide resolved
themacexpert and others added 8 commits July 8, 2024 15:35
Co-authored-by: Erin Shaben <eshaben@icloud.com>
Co-authored-by: Erin Shaben <eshaben@icloud.com>
Co-authored-by: Erin Shaben <eshaben@icloud.com>
Co-authored-by: Erin Shaben <eshaben@icloud.com>
eshaben
eshaben previously approved these changes Aug 13, 2024
Copy link
Contributor

@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.

Last few minor things then this can be merged. Huge effort! Thank you so much! 🙌

tutorials/eth-api/.pages Outdated Show resolved Hide resolved
tutorials/eth-api/thirdweb.md Outdated Show resolved Hide resolved
tutorials/eth-api/thirdweb.md Outdated Show resolved Hide resolved
tutorials/eth-api/thirdweb.md Outdated Show resolved Hide resolved
tutorials/eth-api/thirdweb.md Outdated Show resolved Hide resolved
builders/ethereum/dev-env/thirdweb.md Outdated Show resolved Hide resolved
builders/ethereum/dev-env/thirdweb.md Outdated Show resolved Hide resolved
@eshaben
Copy link
Contributor

eshaben commented Aug 13, 2024

@themacexpert the thirdweb builders page (no need for the tutorials page) will need to be updated. can you please open jira ticket if you haven't already?

dawnkelly09
dawnkelly09 previously approved these changes Aug 13, 2024
Copy link
Contributor

@dawnkelly09 dawnkelly09 left a comment

Choose a reason for hiding this comment

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

lgtm

updates suggested by Erin but not yet accepted.

Co-authored-by: Erin Shaben <eshaben@icloud.com>
@dawnkelly09 dawnkelly09 dismissed stale reviews from eshaben and themself via 0b66ad6 August 13, 2024 16:37
updates to tutorial

Co-authored-by: Erin Shaben <eshaben@icloud.com>
Co-authored-by: Erin Shaben <eshaben@icloud.com>
@themacexpert
Copy link
Contributor Author

@themacexpert the thirdweb builders page (no need for the tutorials page) will need to be updated. can you please open jira ticket if you haven't already?

This PR modifies both the builders page and the tutorial pages... what would you like to see differently on the Builders page?

@eshaben
Copy link
Contributor

eshaben commented Aug 13, 2024

@themacexpert the thirdweb builders page (no need for the tutorials page) will need to be updated. can you please open jira ticket if you haven't already?

This PR modifies both the builders page and the tutorial pages... what would you like to see differently on the Builders page?

Hahaha forgot a couple keywords, on the chinese docs - need to open a ticket to update the builders page on the chinese docs site 😂

Copy link
Contributor

@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.

🚢

@eshaben eshaben merged commit 9c5d524 into master Aug 13, 2024
1 check passed
@eshaben eshaben deleted the themacexpert/thirdweb branch August 13, 2024 18:10
@themacexpert
Copy link
Contributor Author

@themacexpert the thirdweb builders page (no need for the tutorials page) will need to be updated. can you please open jira ticket if you haven't already?

This PR modifies both the builders page and the tutorial pages... what would you like to see differently on the Builders page?

Hahaha forgot a couple keywords, on the chinese docs - need to open a ticket to update the builders page on the chinese docs site 😂

Perfect! https://opslayer.atlassian.net/browse/DR-2105

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.)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants