Repository navigation
Pixie's readthedocs page needs serious improvement #533
Description
Hi, as I've been playing around with Pixie, there have been several times when I have wondered what something did, and only been able to find sufficient docs in a Clojure counterpart. I was wondering how one could go about updating the readthedocs page for future reference/new users?
I am a college student in between my freshman and sophomore years of school, and I am interested in helping improve the projects I find most interesting.
Any help would be much obliged.
Activity
alekcz commentedon Jun 20, 2017
Hey @egregius313 that's my bad. When I stumbled across pixie it took me forever to get started so I made an attempt to put as much about pixie online. Readthedocs and http://pixielang.org/ were the attempts.
Create an account on readthedocs, drop me your username, and then I'll make you a maintainer.
https://readthedocs.org/accounts/signup/
egregius313 commentedon Jun 20, 2017
I just made an account @alekcz . The username is the same as my github, egregius313
Thanks
alekcz commentedon Jun 20, 2017
@egregius313 You're good to go. Feel free to nuke it and start from a clean slate.
thomasmulvaney commentedon Jun 20, 2017
@alekcz thanks for getting RTD and the website up so long ago. @egregius313 I'm not familiar with ReadTheDocs but is it possible to have the docs on Github and then generated on RTD via webhooks or the like? I think it would be great if updating the docs could be done via PRs - that way improving docs is potentially open to everyone.
egregius313 commentedon Jun 21, 2017
My primary goal is to improve the documentation of the entire Pixie core/stdlib. I really want to improve the situation so that the
docfunction returns something for the majority of the core types.I also want to try and seriously improve the documentation for some of the more complicated parts of Pixie, like the FFI system. I plan to use this both as a way to improve the languages documentation and gain greater familiarity with the language's internals.