Skip to content

/ deno

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

Jump to bottom

docs: write docs for Web APIs #4325

Open
bartlomieju opened this issue Mar 12, 2020 · 20 comments
Open

docs: write docs for Web APIs #4325

bartlomieju opened this issue Mar 12, 2020 · 20 comments
Labels
docs good first issue help wanted

Comments

@bartlomieju
Copy link
Contributor

@bartlomieju bartlomieju commented Mar 12, 2020

Deno strives to be browser compatible where possible; that means we use quite a few Web APIs.

There is not much docs for supported Web APIs at the moment and before 1.0 is released that situation must change. Some of APIs and not fully aligned to spec, while others are not fully implemented (#3557). All that knowledge should be written down and presented to end users to avoid multiple questions/bug reports about purposeful incompatibilities and/or missing implementations.
@bartlomieju bartlomieju added the docs label Mar 12, 2020
@kitsonk
Copy link
Contributor

@kitsonk kitsonk commented Mar 12, 2020 •
edited

The manual is getting a bit heavy/complex. Should we identify first a structure of documents/pages that we would want to cover?

lib.deno.window.d.ts provide available Web APIs that are not part of ECMAScript that Deno currently supports.
@bartlomieju
Copy link
Contributor Author

@bartlomieju bartlomieju commented Mar 12, 2020

The manual is getting a bit heavy/complex. Should we identify first a structure of documents/pages that we would want to cover. lib.deno.window.d.ts provide available Web APIs that are not part of ECMAScript that Deno currently supports.

I strongly agree on manual, but I'd prefer to get ball rolling on this subject. We're definitely gonna put more effort into restructuring docs after API freeze in the end of April. For now I think it's fine to extend manual.
@ematipico
Copy link

@ematipico ematipico commented Mar 17, 2020

Hi there! I'd like to to take a stab to this issue, as it is marked as good first issue.

What should I do to help and how?
@bartlomieju
Copy link
Contributor Author

@bartlomieju bartlomieju commented Mar 18, 2020

@ematipico thanks! The very first thing would be to extend cli/js/web/README.md with a list of all supported Web APIs (so all APIs in cli/js/web/ that are exposed globally).
@ondras
Copy link
Contributor

@ondras ondras commented Mar 31, 2020

@ematipico are you still working on this? I can start doing this if you do not have time.
@ematipico
Copy link

@ematipico ematipico commented Mar 31, 2020

Hi @ondras, yeah feel free to go ahead! I got a mix up with my plans and I don't have much time now. Thank you and sorry!
@ondras
Copy link
Contributor

@ondras ondras commented Mar 31, 2020

@ematipico thanks! The very first thing would be to extend cli/js/web/README.md with a list of all supported Web APIs (so all APIs in cli/js/web/ that are exposed globally).

@bartlomieju
Copy link
Contributor Author

@bartlomieju bartlomieju commented Apr 1, 2020

@ondras yeah that looks good! Next step would be to expand description for each API with its caveats (if there are any, eg. Worker doesn't support structured clone right now).

I am somewhat unsure about the streams/ subdirectory that contains quite a bit of a Streams implementation, but most of it seems to be commented out. Looks like a WIP, so probably not ready for public documentation.

That's correct, streams can be skipped for now.
@ondras
Copy link
Contributor

@ondras ondras commented Apr 1, 2020

Next step would be to expand description for each API with its caveats (if there are any, eg. Worker doesn't support structured clone right now).

Great! May I publish the change now? I am afraid I cannot reliably describe individual caveats related to the implementation, as I am not the author of these modules. Will try to add some rudimentary description of what the stuff does, though.
@ondras
Copy link
Contributor

@ondras ondras commented Apr 2, 2020

@ondras yeah that looks good! Next step would be to expand description for each API with its caveats (if there are any, eg. Worker doesn't support structured clone right now).

@bartlomieju I pushed another update with some rudimentary description texts and implementation notes for some APIs.
@bartlomieju
Copy link
Contributor Author

@bartlomieju bartlomieju commented Apr 2, 2020

@ondras feel free to open a PR, we can iterate there
@ondras ondras mentioned this issue Apr 2, 2020
Merged
@ondras
Copy link
Contributor

@ondras ondras commented Apr 2, 2020

Great, opened #4578.
@euanmat
Copy link

@euanmat euanmat commented Apr 25, 2020

Hello, help wanted ?

Can I help in some way ?
@cknight
Copy link
Contributor

@cknight cknight commented May 2, 2020

Looks like streams could be added now? Assuming @kitsonk is finished?
@kitsonk
Copy link
Contributor

@kitsonk kitsonk commented May 3, 2020

the TranformStream is still waiting to be merged
@bartlomieju bartlomieju mentioned this issue May 7, 2020
Merged
@douglaschalegre
Copy link

@douglaschalegre douglaschalegre commented May 19, 2020

Hello! There still is something to be added to Web APIs docs? i would like to help if needed
@ktfth
Copy link

@ktfth ktfth commented May 20, 2020

I can help too on that issue, what have to be done?
@keshav-bohr
Copy link

@keshav-bohr keshav-bohr commented Jun 7, 2020

Would like to help. Let us know
@gungunfebrianza
Copy link

@gungunfebrianza gungunfebrianza commented Jun 11, 2020

I really want to help also, let us know :) i was playing with Performance API last time :)
@dileonmartin
Copy link

@dileonmartin dileonmartin commented Jun 12, 2020

I would really like to contribute, How can I support ?
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
docs good first issue help wanted
Milestone
No milestone
Linked pull requests

Successfully merging a pull request may close this issue.

None yet
You can’t perform that action at this time.

Follow Lee on X/Twitter - Father, Husband, Serial builder creating AI, crypto, games & web tools. We are friends :) AI Will Come To Life!

Check out: eBank.nz (Art Generator) | Netwrck.com (AI Tools) | Text-Generator.io (AI API) | BitBank.nz (Crypto AI) | ReadingTime (Kids Reading) | RewordGame | BigMultiplayerChess | WebFiddle | How.nz | Helix AI Assistant