Complete ReadTheDocs pages

[benwoo1110]

Currently, the getting started and advanced usage pages are still blank. Looking for anyone that is good at writing + coding to help. You will definitely need to understand the usage of this lib first, some explanation is available at the readme.

The current docs use mkdocs and markdown format. Feel free to suggest any useful lib :)

[Tawishi]

I would like to take up this issue

[benwoo1110]

Yea sure! There is probably quite a lot to do, so you can split them into parts. I think I should draft the sections/pointers that should be included in the documentation as well:

getting started:

• Installation
• Most barebone steps to create basics stdin testcase files
• Explain the built-in values available
• Subtasking with value override
• Generate stdout testcase files with answer script

advanced usage:

• Create your own custom Value
• Create and register your own custom Executor

[Tawishi]

on it!
should I comment here or ping on discord for help/queries?

[benwoo1110]

you can comment here

[Tawishi]

I was only able to install the package after updating python to 3.9. Is that a thing?
If yes, this is worth a mention in the docs

[benwoo1110]

I plan to support 3.8 as well in the next release. So yea you can indicate >=3.8 for the python version.

[Tawishi]

ok

[Tawishi]

quick question, what does value.generate() do?

[benwoo1110]

Sorry for the delayed reply, value.generate() essentially output any file saveable string. For example, RandomInt will generate a number output between a min and max range. (The more programmatic term if you are interested will probably be polymorphism)

[Tawishi]

got it! 👍

[Tawishi]

I was lost in the code, I understood it for the most part.
But how should I start documenting? Where do I start from?

@benwoo1110 I think starting from the Available built-in values would be helpful. What do you suggest?