Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Redo Documentation #33

Open
phase opened this issue Nov 12, 2015 · 5 comments
Open

Redo Documentation #33

phase opened this issue Nov 12, 2015 · 5 comments

Comments

@phase
Copy link
Owner

phase commented Nov 12, 2015

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

@refi64
Copy link
Collaborator

refi64 commented Nov 12, 2015

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.

@phase
Copy link
Owner Author

phase commented Nov 15, 2015

I've started work on this in 2684f4e. I'll probably be focusing on it for a while.

@phase phase self-assigned this Nov 15, 2015
@phase phase removed this from the C Rewrite milestone Nov 16, 2015
@ghost
Copy link

ghost commented Nov 16, 2015

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

@refi64
Copy link
Collaborator

refi64 commented Nov 16, 2015

@Hipe99 Work-in-progress!

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

@phase
Copy link
Owner Author

phase commented Nov 16, 2015

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants