docs: clarify subdomain CID normalization

ipfs / in-web-browsers

Tracking the endeavor towards getting web browsers to natively support IPFS and content-addressing

https://docs.ipfs.tech/how-to/address-ipfs-on-web/

MIT License

349 stars 29 forks source link

docs: clarify subdomain CID normalization #164

Closed lidel closed 4 years ago

lidel commented 4 years ago

This PR adds more detail into "best practices" when implementing ipfs:// URI backed by a subdomain gateway.

Namely, opening a path with CID as-is, to take advantage of DNS normalization built into go-ipfs 0.5+

This should help with native URIs in Brave (https://github.com/brave/brave-browser/issues/10220) when embedded go-ipfs is turned off and other collabs.

johnnymatthews commented 4 years ago

Added a couple of notes. I'm not too clear on the purpose of this doc. Is this a guide instructing the reader to do something? Or are we saying these things happen in this feature?

lidel commented 4 years ago

I've applied suggestions from reviews.

@johnnymatthews – mind taking a final look?

johnnymatthews commented 4 years ago

The rest looks solid to me! Just that one tiny change 😄