Skip to content

Optimize tutorial/example presentation #204

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

Merged
merged 5 commits into from
Oct 13, 2022
Merged

Optimize tutorial/example presentation #204

merged 5 commits into from
Oct 13, 2022

Conversation

salmad3
Copy link
Member

@salmad3 salmad3 commented Oct 11, 2022

Context

  • Creates a master doc for tutorial/examples using their current form - based on what we decide for how to present and host examples/tutorials, this can serve as the primary doc as there aren't other tutorials beyond the getting started ones right now in this repo. The master doc is the index file under the "tutorials" directory.
  • Based on data over the last few weeks from plausible analytics, the two pages primarily hit are the index pages, and the tutorial primarily used is go-libp2p, so this may improve navigation and also improve visibility for the other implementations.
  • Introduces the use of tabs.
  • Based on this proposal, this resolves Improve formatting of libp2p getting started #181, add links to particular examples #182, and is part of Improve Examples section #29, Link to examples in Concepts section of docs #168.

Latest preview

Please view the latest Fleek preview here.

@salmad3 salmad3 added the ready for review PR is ready for review label Oct 11, 2022
@salmad3
Copy link
Member Author

salmad3 commented Oct 11, 2022

If this works, this PR will follow an update to the tabs that will add other implementations, following a similar approach to the implementations page, and will address #29

@salmad3 salmad3 linked an issue Oct 11, 2022 that may be closed by this pull request
Copy link
Member

@p-shahi p-shahi left a comment

Choose a reason for hiding this comment

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

LGTM

@salmad3 salmad3 removed the ready for review PR is ready for review label Oct 13, 2022
@salmad3 salmad3 merged commit 42029e3 into master Oct 13, 2022
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.

add links to particular examples Improve formatting of libp2p getting started
2 participants