Skip to content

Conversation

@alexandratran
Copy link
Contributor

@alexandratran alexandratran commented Feb 8, 2024

This PR updates the Snaps information architecture for more intuitive and feature-oriented categorization, and restructures and edits content as needed.

See the layout on Figma for more information. Fixes #1053.

Preview: https://docs.metamask.io/1053-snaps-ia-revamp/snaps

@alexandratran alexandratran marked this pull request as ready for review February 12, 2024 05:25
@alexandratran alexandratran requested review from a team as code owners February 12, 2024 05:25
@alexandratran alexandratran changed the title [WIP] Revamp Snaps docs IA Revamp Snaps docs IA Feb 12, 2024
@github-actions
Copy link

Preview published: 1053-snaps-ia-revamp

@Montoya
Copy link
Collaborator

Montoya commented Feb 12, 2024

This seems like a better IA. I want to review it with the Snaps engineers before approving though.

Copy link
Member

@Mrtenz Mrtenz left a comment

Choose a reason for hiding this comment

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

Can you make everything expanded by default, like how it was previously?

@alexandratran alexandratran requested a review from Mrtenz February 13, 2024 18:46
@github-actions
Copy link

Preview published: 1053-snaps-ia-revamp

# Conflicts:
#	snaps/reference/jest.md
@alexandratran
Copy link
Contributor Author

@Mrtenz Can you re-review?

@Mrtenz
Copy link
Member

Mrtenz commented Feb 14, 2024

image

Maybe these should be expanded too? And potentially moved to top level instead of "Learn"?

@github-actions
Copy link

Preview published: 1053-snaps-ia-revamp

@Montoya
Copy link
Collaborator

Montoya commented Feb 14, 2024

image Maybe these should be expanded too? And potentially moved to top level instead of "Learn"?

The goal was to have the high level navigation based on what we came up with in Figma. If someone wants to learn about Snaps and how to build Snaps, they should have a place to go for that. If someone just needs reference information, they have a place go to for that too.

@alexandratran
Copy link
Contributor Author

@Mrtenz I hesitate to have everything expanded all at once, because it can cognitively overload the reader. Perhaps once we improve and optimize the style of the sidebar (#1126), we can explore better ways to expand/hide information in the sidebar?

Copy link
Contributor

@bgravenorst bgravenorst left a comment

Choose a reason for hiding this comment

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

Minor feedback

@github-actions
Copy link

Preview published: 1053-snaps-ia-revamp

@alexandratran alexandratran merged commit ce19da4 into main Feb 15, 2024
@alexandratran alexandratran deleted the 1053-snaps-ia-revamp branch February 15, 2024 04:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Revamp Snaps docs IA

5 participants