Can I start a documentation project?

Hi gang,
I like the willingness of the group to come to my aid, even if I get a bit snarky.
I like the programming environment , I would like it more if I could run the desktop version as a native app on my chromebook, either as a direct chromebook app, or an Andriod app. It is an older chromebook, so the android versions it supports are not current.

As I dig through this documentation, and the repository, I notice that, in the repository specifically, there are many links that are broke.

What about a documentation project where the web documentation calls up the GitHub documentation, or even sections of the code in question, so that people don't have to try and sort through the Git Hub to find what they need when looking for how the code works.

This is a very secondary project, I am not super gung ho about it, but I think it could be useful.


All the files in the docs are accessible through this URL, converted on the fly from markdown to HTML, so all the links point to .html files, rather than the .md source file:
http://docs.textadventures.co.uk/quest/

Is that already like what you are suggesting?


What I was looking at is to build on this documentation, more for advanced users, or for people like myself who have various projects with novel problems to work through.

There are the forums, which have a lot of good information hiding in them, the code itself is very sparsely documented, which is fine for the group that is using it, and for other people who have a seasoned sense of coding.

I know it is a bit overboard, but I just had a thought that linking into comments of the code that people have trouble using, being an open source engine could help with some features of the documentation. And it may also be able to help with improvements, etc.

just a thought.


If you are wanting a system that will build documentation from comments in code, it is a good idea in theory but (a) I do not know how the website extracts the data from Githib, have no idea how to extend that to code and do not have access to the system anyway; and (b) there are virtually no comments in the code.

If you can add anything to the documentation, that would be great (there is a style guide by the way).

I have spent many hours trying to improve the documentation over the last year, and it is better than it was, but there is still room for improvement. I think a big issue is finding the page you need, and I am still thinking on that one.


why not use the quest textadventure system to create something like an automated agent to help people find what they need.
The system can log questions as people use it to find solutions, if the question is not understood, or there is not an answer in the system, a prompt can send the person to the Forums, or there can be a special forums section that perhaps automates posts with that persons user name, and then gives them the option to add details?

When the problem is solved, that can be added to the documentation textadventure

does that make sense?


Can you guys create simple game creation problems that follow the tutorial and Quest documentation, and I will built out a game example.

Can we build a Quest game that can both show these games to the player, and have a tutorial mode that uses the game code I build as the basis to follow the student's progress.

Perhaps, when an error is throws, the Quest game can compare the code in question to what is in the game I built and display some kind of tip for fixing the code.

Is that possible?


https://www.useloom.com/

We can also use loom screen capture cloud to make videos explaining different parts of code.

We can even model it after the Khan Academy system of videos,
https://youtu.be/LZCE-4q5f9c
Mutation as a source of variation

where the entire problem is worked out with a narrator,
and important theory that needs to be covered can be discussed.

Starting with something like a kindergarten level and working up to 12th grade examples. for instance.

It has potential for a long term and exciting project, and it might even excite more developers in time. Or train them up. haha.

Cheers.


Broken link in web documentation, 404 Page not Found
http://docs.textadventures.co.uk/quest/guides/using_lists.html

from
http://docs.textadventures.co.uk/quest/types/stringlist.html
and
here
http://docs.textadventures.co.uk/quest/types/list.html


Yes, thank you Pixie and mrangel and K.V. for taking time to participate in the forums, improve code, and write tutorials.

Hopefully we can make some interesting things together.


Hey Pixie,

https://github.com/Khan/live-editor

This seems like it will work. It is a live code editor that runs in the browser, and it creates code evaluation environments for the Khan Academy programming class environment. It is possible to analyze the code written by a user, compare it to what should be done in the example, and then give hints that remind the user where to look to fix their code. The Khan academy curriculum is almost entirely made of YouTube videos explaining concepts, and showing examples. It is paired with documentation and problem spaces to practice and learn.

This is an open source live editor created by Khan Academy. they are short on developers, so this is a take it as it is and adapt it to other purposes tool.

Looks like a fun project.


Log in to post a reply.

Support

Forums