Update and restructure content #840

alexandratran · 2023-06-29T06:28:54Z

Restructure content to de-emphasize beginner/generic dapp content and highlight SDK as recommended method. Add recommended topics for beginners vs experienced devs.
Add and edit some related conceptual content. See more in these PRs: Add web3 architecture diagram #859 Separate concepts out from reference #860
Rephrase and reorganize some topics to be more task-oriented
Update various links, file names, configuration, and redirects

This PR follows the MM dev docs restructure proposal.

(Note: it's easiest to do all restructuring and renaming files in one go, so we can simplify the redirects.)

Fixes #809
Fixes #808

Preview: https://docs.metamask.io/restructure/wallet/

github-actions · 2023-06-29T06:38:35Z

Preview published: restructure

github-actions · 2023-06-29T18:59:19Z

Preview published: restructure

wallet/how-to/interact-with-smart-contracts.md

rajkaramchedu

Looks and reads great.

github-actions · 2023-06-29T20:12:06Z

Preview published: restructure

github-actions · 2023-06-29T20:15:16Z

Preview published: restructure

github-actions · 2023-06-29T20:16:15Z

Preview published: restructure

github-actions · 2023-07-06T20:20:41Z

Preview published: restructure

github-actions · 2023-07-11T20:24:01Z

Preview published: restructure

wallet/assets/web3-architecture.png

Proposing some minor copy adjustments

github-actions · 2023-07-14T18:37:20Z

Preview published: restructure

README.md

vandan · 2023-07-18T01:19:32Z

Developers following the "Get started building a dapp" path from the home page are led to a pretty confusing sequence that doesn't match the description.

By taking them to setup steps, that content doesn't lead them to the tutorial where they actually build a dapp. We should either revert by sending them to the tutorial where there can be references to the pre-requisite setup steps or establish more linkage between the setup steps and the tutorial.

Co-authored-by: Vandan <[email protected]>

github-actions · 2023-07-18T02:10:57Z

Preview published: restructure

github-actions · 2023-07-18T02:11:37Z

Preview published: restructure

alexandratran · 2023-07-18T02:13:46Z

@vandan

Developers following the "Get started building a dapp" path from the home page are led to a pretty confusing sequence that doesn't match the description.

By taking them to setup steps, that content doesn't lead them to the tutorial where they actually build a dapp. We should either revert by sending them to the tutorial where there can be references to the pre-requisite setup steps or establish more linkage between the setup steps and the tutorial.

The first paragraph in the first page of the "Get started building a dapp" section refers explicitly to the tutorial: https://docs.metamask.io/restructure/wallet/how-to/get-started-building/set-up-dev-environment/

Is this not enough linkage?

Also, in our docs, "Get started building a dapp" refers to the beginner/general dapp setup content, which is separate from the more MM-specific content (as described in the MM dev docs restructure proposal). Can you expand on what is a confusing sequence / what doesn't match what description?

BelfordZ · 2023-07-18T17:24:53Z

wallet/how-to/connect/set-up-sdk/index.md

+---
+sidebar_position: 1
+---
+


Are we able to make this autogenerate the cards / items below with a simlar file as wallet/how-to/connect/category.json ? Not sure, but I'd imagine that the description part of the _category_.json would support markdown. The only thing that would be missing would be the note at the bottom I think?

reference: https://docusaurus.io/docs/sidebar/autogenerated#autogenerated-sidebar-metadata

The autogenerated category cards by default don't support displaying bulleted lists with different links, which is the primary need for this page.

I slightly modified the style of the SDK cards to better match the category cards. Let me know if there's a better solution!

Ah I see your point. It is quite nice to see all the items laid out. I think we can achieve the same thing while still using autogenerated indexes by 'swizzling' (more specifically ejecting) the DocCard component or the DocCardList component and modify it to display sub-categories differently (as a list, like you have it). That way it will benefit all the other autogenerated index pages.

Swizzling those components to achieve what we currently have for the SDK would probably take me a long time to figure out, as I'm not experienced with React. Could we stick with my workaround for this PR and return to this issue in the future? Or if someone else is willing to experiment with that, or let me know of the specific solution, that's fine too.

github-actions · 2023-07-18T17:47:23Z

Preview published: restructure

github-actions · 2023-07-18T17:51:18Z

Preview published: restructure

BelfordZ · 2023-07-18T17:58:08Z

Overall it looks great, and I like the structure / documentation guideline that you linked.

The PR is a bit on the big side, making it more difficult to review. If possible, could you split out changes that aren't specifically required as part of this content restructuring? For example, perhaps changes like these could be split out to a seperate PR.

github-actions · 2023-07-18T19:23:42Z

Preview published: restructure

github-actions · 2023-07-18T19:27:46Z

Preview published: restructure

alexandratran · 2023-07-18T19:30:59Z

@MetaMask/dev-ex I've separated out a few tasks into other PRs, and reverted those changes in this PR:

Hopefully that makes it easier to review.

vandan · 2023-07-18T21:47:10Z

@vandan

Developers following the "Get started building a dapp" path from the home page are led to a pretty confusing sequence that doesn't match the description.
By taking them to setup steps, that content doesn't lead them to the tutorial where they actually build a dapp. We should either revert by sending them to the tutorial where there can be references to the pre-requisite setup steps or establish more linkage between the setup steps and the tutorial.

The first paragraph in the first page of the "Get started building a dapp" section refers explicitly to the tutorial: https://docs.metamask.io/restructure/wallet/how-to/get-started-building/set-up-dev-environment/

Is this not enough linkage?

Also, in our docs, "Get started building a dapp" refers to the beginner/general dapp setup content, which is separate from the more MM-specific content (as described in the MM dev docs restructure proposal). Can you expand on what is a confusing sequence / what doesn't match what description?

I see the reference to the tutorial now. Yeah, I was just expecting there to be a sequential flow that leads developers from setup to tutorial (for example if they just keep reading through each page and choosing "next"). I think it could be improved by highlighting the tutorial path at the end of setup steps vs mentioning it only at the beginning.

# Conflicts: # wallet/how-to/display/tokens.md

github-actions · 2023-07-19T22:40:23Z

Preview published: restructure

# Conflicts: # wallet/index.md

github-actions · 2023-07-25T21:17:24Z

Preview published: restructure

vandan · 2023-07-27T21:09:19Z

@shanejonas I assigned you to this one to share any thoughts you have on the adjusted content structure.
(there's not as much to technically review, but I thought you might be interested in the new onboarding paths)

vandan

I've reviewed the content structure and copy changes. Overall these changes provide an improved set of paths for developers with distinct needs. The additional concepts sections are generally helpful to all developers as well.

Update and restructure content

1e3f24a

alexandratran requested review from a team and ziad-saab as code owners June 29, 2023 06:28

fix errors

be231b4

Move SDK into connect section

ffe73ef

rajkaramchedu reviewed Jun 29, 2023

View reviewed changes

wallet/how-to/interact-with-smart-contracts.md Show resolved Hide resolved

rajkaramchedu approved these changes Jun 29, 2023

View reviewed changes

alexandratran added 2 commits June 29, 2023 13:08

update wallet homepage cards

881deb1

Update contract page

a2cf870

fix apostrophes

cf9783d

Add more concepts

d605ed0

update arch diagram

3b57fa9

alexandratran requested a review from vandan July 11, 2023 20:41

vandan reviewed Jul 11, 2023

View reviewed changes

wallet/assets/web3-architecture.png Outdated Show resolved Hide resolved

Update architecture.md (#850)

d5d3124

Proposing some minor copy adjustments

vandan reviewed Jul 18, 2023

View reviewed changes

README.md Outdated Show resolved Hide resolved

alexandratran and others added 2 commits July 17, 2023 19:06

Update arch diagram

8a47c6d

Update README.md

f646285

Co-authored-by: Vandan <[email protected]>

BelfordZ reviewed Jul 18, 2023

View reviewed changes

update sdk card styling

c8beeeb

add icons

63c8a2e

revert changes made in separate PRs

dc8d788

minor fix

6cd7a89

alexandratran added 4 commits July 19, 2023 15:18

link back to tutorial

5fd525c

Merge branch 'main' into restructure

e78b0bb

# Conflicts: # wallet/how-to/display/tokens.md

revert contributing changes

496fd43

minor fixes

944e954

alexandratran requested a review from httpJunkie July 21, 2023 21:04

vandan assigned shanejonas Jul 21, 2023

alexandratran added 2 commits July 24, 2023 12:30

Merge branch 'main' into restructure

514c828

# Conflicts: # wallet/index.md

fix link

746c1d1

vandan approved these changes Aug 2, 2023

View reviewed changes

alexandratran merged commit 266a770 into main Aug 2, 2023
11 checks passed

alexandratran deleted the restructure branch August 2, 2023 17:40

alexandratran mentioned this pull request Aug 15, 2023

Updated to make task focused #810

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update and restructure content #840

Update and restructure content #840

alexandratran commented Jun 29, 2023 •

edited

Loading

github-actions bot commented Jun 29, 2023

github-actions bot commented Jun 29, 2023

rajkaramchedu left a comment

github-actions bot commented Jun 29, 2023

github-actions bot commented Jun 29, 2023

github-actions bot commented Jun 29, 2023

github-actions bot commented Jul 6, 2023

github-actions bot commented Jul 11, 2023

github-actions bot commented Jul 14, 2023

vandan commented Jul 18, 2023

github-actions bot commented Jul 18, 2023

github-actions bot commented Jul 18, 2023

alexandratran commented Jul 18, 2023 •

edited

Loading

BelfordZ Jul 18, 2023 •

edited

Loading

alexandratran Jul 18, 2023

BelfordZ Jul 18, 2023

alexandratran Jul 18, 2023 •

edited

Loading

github-actions bot commented Jul 18, 2023

github-actions bot commented Jul 18, 2023

BelfordZ commented Jul 18, 2023

github-actions bot commented Jul 18, 2023

github-actions bot commented Jul 18, 2023

alexandratran commented Jul 18, 2023

vandan commented Jul 18, 2023

github-actions bot commented Jul 19, 2023

github-actions bot commented Jul 25, 2023

vandan commented Jul 27, 2023

vandan left a comment

Update and restructure content #840

Update and restructure content #840

Conversation

alexandratran commented Jun 29, 2023 • edited Loading

github-actions bot commented Jun 29, 2023

github-actions bot commented Jun 29, 2023

rajkaramchedu left a comment

Choose a reason for hiding this comment

github-actions bot commented Jun 29, 2023

github-actions bot commented Jun 29, 2023

github-actions bot commented Jun 29, 2023

github-actions bot commented Jul 6, 2023

github-actions bot commented Jul 11, 2023

github-actions bot commented Jul 14, 2023

vandan commented Jul 18, 2023

github-actions bot commented Jul 18, 2023

github-actions bot commented Jul 18, 2023

alexandratran commented Jul 18, 2023 • edited Loading

BelfordZ Jul 18, 2023 • edited Loading

Choose a reason for hiding this comment

alexandratran Jul 18, 2023

Choose a reason for hiding this comment

BelfordZ Jul 18, 2023

Choose a reason for hiding this comment

alexandratran Jul 18, 2023 • edited Loading

Choose a reason for hiding this comment

github-actions bot commented Jul 18, 2023

github-actions bot commented Jul 18, 2023

BelfordZ commented Jul 18, 2023

github-actions bot commented Jul 18, 2023

github-actions bot commented Jul 18, 2023

alexandratran commented Jul 18, 2023

vandan commented Jul 18, 2023

github-actions bot commented Jul 19, 2023

github-actions bot commented Jul 25, 2023

vandan commented Jul 27, 2023

vandan left a comment

Choose a reason for hiding this comment

alexandratran commented Jun 29, 2023 •

edited

Loading

alexandratran commented Jul 18, 2023 •

edited

Loading

BelfordZ Jul 18, 2023 •

edited

Loading

alexandratran Jul 18, 2023 •

edited

Loading