Skip to content

feat: add technical docs #543

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

Draft
wants to merge 4 commits into
base: develop
Choose a base branch
from

Conversation

kallebysantos
Copy link
Contributor

@kallebysantos kallebysantos commented May 21, 2025

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

- to rebase later
@kallebysantos
Copy link
Contributor Author

kallebysantos commented May 21, 2025

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.

@nyannyacha
Copy link
Contributor

nyannyacha commented May 21, 2025

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

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.

2 participants