Feature Request: Edge Function Description/Notes

[MAlMazrou]

Would be great if Edge Functions in Supabase had a simple "description" or "notes" field.
Just a plain text box where devs can leave context about what the function does, usage notes, or reminders for the team.
Nothing fancy, just lightweight documentation tied directly to the function instead of having to keep it somewhere else.
And I wouldn't mind having version history for this field.

[silentworks]

I mean it's a Typescript file so why not just write the notes as comments inside of the file?

[MAlMazrou]

@silentworks My current workaround is to put my notes in a separate TypeScript file (for example, README.ts), but since this file contains only comments and isn’t referenced in the module graph, Deno’s bundler prunes it (via tree-shaking/dead code elimination).
In practice, I have to explicitly import it somewhere, for example, import README.ts in function.ts and then import function.ts in index.ts, or just import README.ts directly in index.ts before deploying it to force it into the final bundle.
Doing that for every function is tedious, so a dedicated built-in notes section would be much more convenient, I just wanted to share my thoughts.

By the way if there is a better way, or am not doing it in the right way kindly enlighten me, thanks :)

[silentworks]

Yeah I've noticed the pruning of non ts files which aren't imported into the main function file too. I wonder if this is a bug or if this feature should be an opt-in instead because I've seen other people complaining about this happening to their files. It just magically disappears when you deploy the code.

Personally I would prefer if they allowed for a markdown file to be a part of the deployed files to keep track of stuff like this, having it as part of the UI doesn't feel very developer friendly to me. But having both would also be a great option, so in the UI and in a markdown file.

[MAlMazrou]

@silentworks I would really wish to have it as a file, as you said its more developer friendly, but if implementing this fix is complicated or time consuming, I wouldn't mind having it as description field similar to the tables for now.