manual Reorganize deno docs off rewrite

Reorganize deno docs off rewrite

Open yirenlu92 opened this issue 1 year ago • 5 comments

Sep 14 '22 16:09 yirenlu92

Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you all sign our Contributor License Agreement before we can accept your contribution.
14 out of 15 committers have signed the CLA.

:white_check_mark: sigmaSd
:white_check_mark: grevend
:white_check_mark: aslilac
:white_check_mark: lucacasonato
:white_check_mark: khaosdoctor
:white_check_mark: k-nasa
:white_check_mark: dsherret
:white_check_mark: josephrocca
:white_check_mark: simhnna
:white_check_mark: kitsonk
:white_check_mark: yirenlu92
:white_check_mark: ry
:white_check_mark: jflatow
:white_check_mark: crowlKats
:x: Yiren Lu

Yiren Lu seems not to be a GitHub user. You need a GitHub account to be able to sign the CLA. If you have already a GitHub account, please add the email address used for this commit to your account.
_{You have signed the CLA already but the status is still pending? Let us recheck it.}

Sep 14 '22 16:09 CLAassistant

@yirenlu92 the CI errors are related to type checking of the examples... I found a few that are failing and either fixed them or ignored them. There are still some that are buried where a dependency of something in an example is failing and currently CLI doesn't give a useful stack trace to find out where the problem is upstream.

Sep 27 '22 01:09 kitsonk

Section: https://deno.land/manual@890e88818cf8b9dc6560e8031d64261af5319f69/getting_started/first_steps#01570 has some rather confusing text when rendered:

Sep 27 '22 01:09 kitsonk

In section 4 there's no documentation for Deno namespace APIs. For example file system stuff.
Section 4.4 Web Platform APIs doesn't seem exhaustive. For example it's missing WebGPU.
It feels like 6.3 "Using WebAssembly" belongs in section 4 Runtime section.
Section 6.4 "Interoperating with Node and NPM" feels buried. I think it belongs in "Basics" and should probably be renamed to "How to import NPM modules". It also contains a lot of unnecessary cruft - we should simply tell people import express from "npm:express"
Tools should come before Advanced.
Tools subsections titles should match subcommand. So instead of "script installer" just call it "deno install"
References section should have links to autogenerated docs for std, built-in APIs, deno.land/x and probably also explain how these auto-generated docs work. @kitsonk can help here.