Add developer-user documentation for `EdgeRuntime.*`

[AntonOfTheWoods]

Improve documentation

Describe the problem

There is basically zero admin-dev-user documentation for the EdgeRuntime namespace. This means that only experienced Rust developers, who have the knowledge and time necessary, have any chance of understanding how EdgeRuntime.* classes/methods can be used.

Describe the improvement

At least a basic explanation of the public interfaces, along with explanation of the features from upstream Deno that have been disabled (e.g, an exhaustive list of the the FS-related functionalities that have been put in the banned list, etc.). Comprehensive typescript types + a little extra jsdoc would possibly suffice.

Additional context

Currently this makes the project not really resemble an open source project at all.

Many of these things should absolutely be documented somewhere - if they are documented somewhere then it really shouldn't take very long to extract a usable subset for public consumption. If they simply aren't documented at all, then that seems like a pretty big black mark against Supabase the company - open source or not if you have absolutely no documentation for a reasonably major part of your product offering then how are you expected to provide a reliable service based on it?

[kallebysantos]

Hi @AntonOfTheWoods 🙏 Its a pretty great suggestion, at mean time I advise you to have a look in the types defs as well the examples and tests folders.

[AntonOfTheWoods]

Hi @AntonOfTheWoods 🙏 Its a pretty great suggestion, at mean time I advise you to have a look in the types defs as well the examples and tests folders.

Thanks for that @kallebysantos . Definitely my bad not finding those types... but the examples are only really useful when you are just getting started. It all seems to be just basic Deno stuff - nothing that showcases the differences and gotchas - and that is what is super painful with edge-runtime.

The tests - they are certainly a little more useful. I guess I could have done a search for all the .ts files in the repo but their current location was not somewhere I would ever have thought to look. I will study those further - thanks.

But again, the absolutely MASSIVE frustration with almost ALL of Supabase's repos is an almost complete lack of useful documentation. EVERYTHING is COMPLETELY focussed on pushing your SAAS offering, and the fact that it is based an "open source" project seems like nothing more than advertising. In many cases it would take a single maintainer maybe 1h a month to make sure (checking and updating) project level documentation focussed not towards SAAS customers but to potential contributors and other users of the open source projects (including new hires!). And yet month after month, year after year, there is still nothing. Seriously, what is the bus factor of some of your teams? One accident and you might have serious issues even maintaining your SAAS offering... Clearly this is a leadership issue - nobody likes writing or updating documentation. Does anyone like cleaning their room? No but it actually does need to get done, and a proper leader makes sure it does.

[github-actions[bot]]

🔕 This issue 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.

[AntonOfTheWoods]

Please close this if open source documentation is not what Supabase is about.

[kallebysantos]

Hi @AntonOfTheWoods, I've started documenting PR #543 and have already wrote about I have better domain. However, since the edge-runtime is a huge and complex project, it may take some time, so any contributions are welcome.

[github-actions[bot]]

🔕 This issue 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.

[kallebysantos]

bot reply