feat: add r/docs/img_embed

[moul]

Embedding an image.

[Gno2D2]

I'm a bot that assists the Gno Core team in maintaining this repository. My role is to ensure that contributors understand and follow our guidelines, helping to streamline the development process.

The following requirements must be fulfilled before a pull request can be merged.
Some requirement checks are automated and can be verified by the CI, while others need manual verification by a staff member.

These requirements are defined in this configuration file.

Automated Checks

🟢 Maintainers must be able to edit this pull request (more info)
🟢 The pull request head branch must be up-to-date with its base (more info)

Manual Checks

No manual checks match this pull request.

Debug

Automated Checks

Maintainers must be able to edit this pull request (more info)

If

🟢 Condition met
└── 🟢 On every pull request

Then

🟢 Requirement satisfied
└── 🟢 Maintainer can modify this pull request

The pull request head branch must be up-to-date with its base (more info)

If

🟢 Condition met
└── 🟢 On every pull request

Then

🟢 Requirement satisfied
└── 🟢 Head branch (moul:dev/moul/img-embed) is up to date with base (master): behind by 0 / ahead by 4

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

📢 Thoughts on this report? Let us know!

[jefft0]

On a dev call, I thought we said that embedding an image from a random web site is a security risk.

[moul]

@jefft0, I don't remember this.

Our goal is to create a list of whitelisted domains for auto-preview. Imgur is, if I recall correctly, moderated. Therefore, Gnoweb can be updated to disable automatic previews for non-whitelisted domains while still allowing links to any URL, whether for images or other content.

Note: This example aims to discourage users from uploading all their files in base64 on the chain. Such cases should be very advanced and only relevant in rare situations. By default, image embedding or linking should be the preferred method for sharing assets.

[n0izn0iz]

can't wait for gnoweb refacto so we can add ipfs:// embed support :)

[moul]

I will likely address all the bad practices I see everywhere by providing examples here. Here’s my shortlist:

• Base64 meme images (inefficiency)
• Writing JSON encoders (makes code hard to read, mixes concepts and targets)
• Creating top-level functions for everything instead of promoting maketx run

I will write new examples soon and open issues so we can update the tools (e.g., gnoweb).