search

jstedfast / MailKit

A cross-platform .NET library for IMAP, POP3, and SMTP.
http://www.mimekit.net
MIT License
6.04k stars 809 forks source link

doc: add link to examples #1719

Closed rklec closed 4 months ago

rklec commented 4 months ago

As a new user of this library, looking into the Readme and docs for the first time, I struggled to find the amazing(!) complete examples provided in the documentation.

IMHO thus giving a short link there, that there are more examples, is very helpful!

jstedfast commented 4 months ago

Those examples are designed to be included in the API Reference docs and aren't really designed as standalone examples.

It would be more appropriate to link to the samples directory, but I don't really see the point of that since it's in the file listing at the top of the GitHub page.

jstedfast commented 4 months ago

How about this modified verbiage/link instead?

rklec commented 4 months ago

Ah yeah, also found the /samples directory now, but the other examples have more examples. I would personally link to both, as they are short examples and bigger ones.

But I saw you've merged it in https://github.com/jstedfast/MailKit/commit/51462a1197d52d190b2bfeec588a14a7eccd952c.

How about this modified verbiage/link instead?

Don't know, do you like that more? Usually that's not necessary AFAIK as GitHub automatically expands links.

Created https://github.com/jstedfast/MailKit/pull/1720 for the samples dir now.