stdweb icon indicating copy to clipboard operation
stdweb copied to clipboard

Add link to API doc in the README

Open maudnals opened this issue 5 years ago • 6 comments

Would be nice to have it linked!
https://docs.rs/stdweb/*/stdweb/

maudnals avatar Mar 09 '19 23:03 maudnals

...but it is linked in the README? (:

koute avatar Mar 09 '19 23:03 koute

Yes, right :) - It's rather small, I missed it, my bad. Maybe just add a title section similar to "donate"?
I can create a PR.

maudnals avatar Mar 09 '19 23:03 maudnals

No worries. (:

Hmm... how about putting an extra link in the "Getting started" or "Example" section? Do you think that would be better that what we currently have from the POV of someone who's new?

koute avatar Mar 09 '19 23:03 koute

(1) Sure, an extra link in the "Getting started" section would work too!
(2) Actually, this makes me realize that a short table of contents for the README might help too - because it's not extra short, and "Getting started" is in between sections and comes after the long example section. With a table of contents newcomers could directly jump to Getting started.

maudnals avatar Mar 09 '19 23:03 maudnals

Then I would be fine with putting an extra link in the "Getting started" section!

Adding a TOC feels like a slight overkill however. (:

koute avatar Mar 10 '19 00:03 koute

OK, here is the PR for it: https://github.com/koute/stdweb/pull/329

maudnals avatar Mar 10 '19 00:03 maudnals