search

mys-lang / mys

The Mys programming language - an attempt to create a statically typed Python-like language that produces fast binaries. See https://mys-lang.org for more information.
Other
132 stars 5 forks source link

[docs] Sphinx generated documentation #19

Closed sbordeyne closed 3 years ago

sbordeyne commented 3 years ago

It's still a WIP, I need to improve on the docs hierarchy, as well as add the docs for the mys packages (in the mys stdlib)

pfalcon commented 3 years ago

No review from the project architect? Two important sections - Tutoral and Contributing - completely removed from the README? Nice.

eerimoq commented 3 years ago

We discussed the transition from a huge readme to using readthedocs on Discord. These sections were moved to readthedocs. Unfortunately this was merged before the readme was updated with a link to readthedocs. This should be addressed promptly. The move to readthedos is a work in progess, which I hope @Dogeek will continue on soon as documentation is very important, both for Mys users and Mys developers.

There should probably be a section about contributing both in the readme and on readthedocs.

https://mys.readthedocs.io/en/latest/

pfalcon commented 3 years ago

Please keep in mind that "only cowards read the docs", and README is what people see when they hit https://github.com/mys-lang/mys . Having a quick tutorial and quick contrib words in README is rather useful.

eerimoq commented 3 years ago

Agree.