You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
The issue title tells it all. It is always a good idea to write a GitHub readme.md file that would be some sort of an introduction to a package, but it should also be used as part of the documentation on the front page. Converting that file into the HTML index page is very helpful.
(I am obviously influenced by the fact that typedoc does exactly that, and I found that a really useful feature when writing a documentation.)
The text was updated successfully, but these errors were encountered:
The issue title tells it all. It is always a good idea to write a GitHub readme.md file that would be some sort of an introduction to a package, but it should also be used as part of the documentation on the front page. Converting that file into the HTML index page is very helpful.
(I am obviously influenced by the fact that typedoc does exactly that, and I found that a really useful feature when writing a documentation.)
The text was updated successfully, but these errors were encountered: