o icon indicating copy to clipboard operation
o copied to clipboard

Redo Documentation

Open phase opened this issue 10 years ago • 5 comments
trafficstars

Pyth's docs look fabulous. They're clean, organized, and they look professional. O's docs are unorganized, messy, not updated, and they look terrible. I want to completely redo the documentation in reStructuredText because RTD supports it the best. I'd also like to make a tutorial to get people using the language., which can have its own section on the docs.

/cc @kirbyfan64

phase avatar Nov 12 '15 01:11 phase

O's docs aren't really bad, especially in comparison to some of the crap I've seen (I'm looking at you, SDL!). Though I agree with rST being better with RTD. I migrated Mypy's docs to Sphinx+rST in the past.

refi64 avatar Nov 12 '15 02:11 refi64

I've started work on this in https://github.com/phase/o/commit/2684f4ed85a8a9311c63484450f67c79866ab376. I'll probably be focusing on it for a while.

phase avatar Nov 15 '15 09:11 phase

The new docs are not as extensive as the old docs.

ghost avatar Nov 16 '15 20:11 ghost

@Hipe99 Work-in-progress!

@phase Maybe the rest of the Markdown docs could just be converted as-is?

refi64 avatar Nov 16 '15 20:11 refi64

I'd rather make the new docs from scratch, as the old docs don't recognize all the changes made with the new interpreter.

phase avatar Nov 16 '15 23:11 phase