edge-runtime icon indicating copy to clipboard operation
edge-runtime copied to clipboard

[WIP] feat: add technical docs

Open kallebysantos opened this issue 7 months ago • 4 comments

[!WARNING]
Working in progress, I'll be using the GitHub integrated markdown editor in order to attach useful images

  • Commits must be clean up/rebase before switch to review

What kind of change does this PR introduce?

docs update

What is the current behavior?

Missing technical relevant information about Edge Runtime as well upstream Deno.

What is the new behavior?

This PR solves #537 by adding more relevant docs about all internal crates and the whole project structure

starting from the ones I really understand well: ai

kallebysantos avatar May 21 '25 11:05 kallebysantos

Hi @nyannyacha, is possible to turn off ci pipeline for this specific PR while its in draft? So we can avoid waste computer time on it.

Or may you have any recommendations for how should I do attach images to .md files? I'm planning to draw some illustrations for it.

kallebysantos avatar May 21 '25 11:05 kallebysantos

Hi @nyannyacha, is possible to turn off ci pipeline for this specific PR while its in draft? So we can avoid waste computer time on it.

Opened a PR for it 😋 #544 But @laktek is coming back from vacation tomorrow, so it probably won't get merged until then.

Or may you have any recommendations for how should I do attach images to .md files? I'm planning to draw some illustrations for it.

When I wanted to reference images in Markdown, I placed the images in the assets directory. You can see how the asset is referenced here: https://github.com/supabase/edge-runtime/blob/develop/DEVELOPERS.md?plain=1#L89

nyannyacha avatar May 21 '25 13:05 nyannyacha

@kallebysantos The CI related changes have just been merged now. Please rebase to the latest changes and make sure everything is working properly 😄

nyannyacha avatar May 26 '25 03:05 nyannyacha

🔕 This PR is stale because it has been open 60 days with no activity. Remove stale label or comment or this will be closed in 7 days.

github-actions[bot] avatar Nov 17 '25 02:11 github-actions[bot]

bot reply

kallebysantos avatar Nov 17 '25 10:11 kallebysantos