search

vala-lang / valadoc-org

Build tools used to generate valadoc.org
https://valadoc.org
GNU Lesser General Public License v2.1
84 stars 25 forks source link

Integrate tutorials to valadoc #92

Open Nine-H opened 7 years ago

Nine-H commented 7 years ago

there are vala tutorials/examples/samples all over the web, it might be worthwhile to pull these into valadoc and put the responsibility for keeping them accurate/updated/relevant in the hands of the the documentation team.

arteymix commented 7 years ago

The best would be to render the manual that ships with the language and improve it upstream. I would love to have something like a https://valadoc.org/manual endpoint.

I can work on that for the rewrite in #40 as it will likely require some backend processing.

elegaanz commented 7 years ago

It would be great to have the manual on Valadoc, but I think we could also have tutorials about libraries (for instance, a "Create a custom widget with GTK+ 3"), and not only the language itself (on an endpoint like https://valadoc.org/gtk+-3.0/tutorials/custom-widget). But maybe we could do that after #40 is merged, because it's a bigger feature.

astavale commented 7 years ago

The Vala Reference Manual is available as HTML at http://vala-project.org/doc/vala/ and as a PDF at http://vala-project.org/doc/manual.pdf

arteymix commented 7 years ago

@astavale what about having doc.vala-project.org instead of valadoc.org? Centralizing all the resources would be ideal for users.

@Bat41 per-package tutorials would be truly awesome with embedded snippets. A snippet evaluator (remote or in WebAssembly) would be a really good project.

arteymix commented 7 years ago

@Bat41 I'll try to work something out with Pandoc and the current PHP implementation (for tutorials)

elegaanz commented 7 years ago

@Bat41 per-package tutorials would be truly awesome with embedded snippets. A snippet evaluator (remote or in WebAssembly) would be a really good project.

By the way it would be great to have a way to compile Vala code to WebAssembly. :smile:

If we use Pandoc for tutorials, it means that we could write them in almost whatever we want (like MarkDown, ReStructured Text, Latex, etc), right?

arteymix commented 7 years ago

@Bat41 I'm pretty sure that's right! It will ease the importation of existing tutorials around.