-
Notifications
You must be signed in to change notification settings - Fork 73
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
Revamp ThirdWeb Docs #942
Conversation
There was a problem hiding this 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"
Co-authored-by: Erin Shaben <[email protected]>
Co-authored-by: Erin Shaben <[email protected]>
Co-authored-by: Erin Shaben <[email protected]>
Co-authored-by: Erin Shaben <[email protected]>
There was a problem hiding this 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
There was a problem hiding this 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!
Co-authored-by: Erin Shaben <[email protected]>
Co-authored-by: Erin Shaben <[email protected]>
Co-authored-by: Erin Shaben <[email protected]>
Co-authored-by: Erin Shaben <[email protected]>
There was a problem hiding this 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! 🙌
@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? |
There was a problem hiding this 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 <[email protected]>
updates to tutorial Co-authored-by: Erin Shaben <[email protected]>
Co-authored-by: Erin Shaben <[email protected]>
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 😂 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🚢
|
Description
Freshens up ThirdWeb Docs.
Checklist
moonbeam-docs-cn
repo, I have created a ticket for the translations in Jiramoonbeam-mkdocs
to update redirectsmove-pages.py
script to move the pages and update the image paths on the chinese repomoonbeam-docs-cn
compress-images.py
script to compress the images.moonbeam-docs-cn
repo to use the new variablesCorresponding PRs
Please link to any corresponding PRs here.
After Translation Requirements
moonbeam-docs
repo to remove imagesmoonbeam-docs
repo to remove variablesmoonbeam-mkdocs
repo to add redirects for Chinese siteItems to be Updated
Please list any of the items that will need to be added or deleted after the translations are done here.