search

denoland / website_feedback

For reporting issues & suggestions for deno.com and deno.land
9 stars 1 forks source link

Display README.md if default module has no moduleDoc #21

Open kitsonk opened 2 years ago

kitsonk commented 2 years ago

Now that we are displaying a doc view by default, a lot of modules don't have good JSDoc. While this has been the standard for Rust and Go, that a lack of inline docs generates "bad" display of information we need to evolve towards that.

For example https://deno.land/x/dejs, the 10th most popular module, is just confusing to a user.

Currently if a module doesn't have a default module we display the README after the directory listing.

I propose if the default module doesn't have moduleDoc that we display the README after the symbol list.

@crowlKats we just need to figure out if you want apiland to figure that out for you or not. While it wouldn't deliver the content, it could provide a flag/prop with a reference to the README.md, might want that for the index too.

jhechtf commented 2 years ago

Can we just do this by default? A lot of packages include some instruction and usages in the readme which are sort of valuable.

nberlette commented 2 years ago

It would be nice to have it in the sidebar file list as well. When navigating to the docland site, I typically want to see the moduleDoc more than the README. But when I'm on deno.land, it's frustrating to have to manually navigate to it. Inhibiting users from seeing README (where most modules place important info for usage/installation), kind of goes against the whole idea and name of the file...

The thought actually crossed my mind to delete one of my module's mod.ts files, just so the README would be displayed by default again (as it is on deno_dom). 🙄