Content for the Website

[daviddias]

Heey Jesseeee, here is what you askes. With ❤️ @diasdavid and @victorbjelkholm

@jesseclay

multiformats website

Sitemap

|- /                 - Landing Page
|- /multiaddr
|- /multibase
|- /multicodec
|- /multikey
|- /multihash
|- /multistream
|- /utilities        - Collection/Gallery/Index of different browser tools for dealing with multiformats
|- /media
|- /specifications   - External link to https://github.com/multiformats/specs

Navigation

Every page should contain the same navigation bar, containing links to the subpages of the multiformats website and other places of relevant information for multiformats interested users.

The navigation bar should float on the right with the user as they uncover the website, having the extra task of offering the users a way to get back to the beginning.

List of items in the navigation:

• Home - /
• quick access to each multiformat page
• Utilities - /utilities
• Media - /media

---

• Github (external) - https://github.com/multiformats/multiformats
• Specification (external) - https://github.com/multiformats/specs

Pages

page: Landing page

Above the fold

• Title: Multiformats
  // * Tagline: Set of self-describing values to enable protocol agility, interop and avoid vendor lock-in.
• Tagline: self-describing values for future proofing systems

Below the fold

"Never change is considered harmful"

{insert paragraph explaining why it's considered harmful}

Examples: where Multiformats would have saved the day

• Assuming that things will never change is considered harmful
• sha-pocalypse

section: Features

• Self-describing - No out-of-band information, once you have the value, you also know how to read it
• Interop - Implement your protocols and applications in a way where it's easy to change out when you need it and collaborate with others
• Future proof - Since you're not stuck with your format, it'll be easy to migrate when the time comes
• Avoid protocol lock-in
• Binary format for performance and compactness
• Human-readable version for good UX and debugging

section: List of Multiformats: with link to that format listed on the "Multiformats" page

• Includes illustrations to explain

Example:
multihash - For hash function values
multiaddr - for network addresses

Publications & Talks

• Multiformats explanation at TADSummit - https://youtu.be/IleIFjfbpOQ?t=10m54s
• source more talks

Community

• Same as on the other websites, beta.libp2p.io for example

page: (individual multiformats).forEach(doSubPage)

Every individual multiformats webpage (located at a subpage of the root) should contain the following:

• Splash
• Description / Why
• Features
• Decomposer
• Implementations table
• Talks
• Community

Ideally, this information should also be available through Github, the other entrypoint. It would be perfect if we can have a way to keep both in sync.

Multiformats available:

• https://github.com/multiformats/multicodec
• https://github.com/multiformats/multihash
• https://github.com/multiformats/multiaddr
• https://github.com/multiformats/multigram
• https://github.com/multiformats/multibase
• https://github.com/multiformats/multistream

You can use the information on those Github repos to populate the individual subpages

page: Utilities multiformats.io/utilities

Sections

• Decomposers
• JS Playground
• Other utilities

Inspirations

A very basic webpage with no too many illustrations

• http://leveldb.org/