telegraph icon indicating copy to clipboard operation
telegraph copied to clipboard
verified publisher icon dcdunkan

Better Documentation

Open dcdunkan opened this issue 4 years ago • 6 comments

The current documentation (both JSDocs and README) is pretty bad. Of course, I have documented everything. But they are not too good. So we should have some better docs.

  • [ ] Better JSDocs.
  • [ ] Better and minimal README.
  • [ ] ~Move the complete docs to GitHub pages(, maybe?).~
  • [ ] Include argument types of methods to Docs.

dcdunkan avatar Jan 31 '22 19:01 dcdunkan

I think a comprehensive README could be fine for a project of this scale. It should introduce

  • introduce the concepts of this lib
  • outline some non-obvious markdown differences
  • include a manually written API reference.

If those things are included, I don't think any more docs will be missed.

KnorpelSenf avatar Feb 03 '22 13:02 KnorpelSenf

@KnorpelSenf Sure, will do. Thanks!

dcdunkan avatar Feb 03 '22 13:02 dcdunkan

Hey.

When do you plan to merge this PR?

uqe avatar Nov 04 '23 23:11 uqe

Do you mean #6?

KnorpelSenf avatar Nov 05 '23 07:11 KnorpelSenf

@KnorpelSenf, yes.

The current version does not support the href attribute for links. I see that this has been fixed in #6.

uqe avatar Nov 08 '23 06:11 uqe

@dcdunkan?

KnorpelSenf avatar Nov 09 '23 08:11 KnorpelSenf