Updates to Wiki documentation

I’d say we could even seperate the top level landing pages (Developer/How to contribute) entries somehow like that:

  1. Contributing guidelines (also: reporting, tracking)
  2. Basics/Preparing your workbench (ssh, VNC, IDE, Git, …)
  3. Zynthian priciples (systemd, file formats, Xwindow…)
  4. Zynthian Codebase and debugging (zynthian repos, code, py)
  5. Supported Devices/CtrlDev
  6. Customize engines (comments, ratings, tutorials, lv2-ttl)
  7. Coding Plugins
  8. Editing Wiki

Certainly seems sensible.

If I could remember how to add new pages….

Or do I need to be empowered…?

I think the best way is to create a link to the non existing page on another page (preferebly the Development landing page here). Then click the red link and “create this page”. So it doesn’t get lost in space.

I think you can also enter the non existing URL like https://wiki.zynthian.org/index.php/NonExistingURL to your browser. But that way it might accidentally get lost in the void unlinked.

Ok. New pages created. I don’t think I’ve dumped any info.

7 Likes

This is fantastic work @wyleu ! I didn’t know it existed until @hannesmenzel pointed it out. There’s no link to Zynthian Development in the Zynthian Users Guide (at least I’ve never seen it…).

This provides very thorough and readable background information on how the Zynth works. Thanks!

Kind regards,

Hans.

1 Like

This is a great move forward. I made a suggestion here how to bring these in a human readable order.

Maybe we should put some things in more distinctive places (like reserve the “contribution” page for that matter and get all the zynthian repository stuff to another place?

1 Like

Baby steps; I was chiefly concerned with blowing large chunks of data away as has happened before in the twitchy world of mediaWiki. It has history but I’ve never used it, along with no doubt many fine feature it has. . .

I’m pretty sure I did tables once but layout is very much an exercise in trial and error.

There is it’s just a fair way down . . .

How about adding a zynthian development link to the forum sticky post about the wiki. Who did the post, was it @riban ?

There really is some depth in the wiki now, I went through and added some more internal links to try and guide people around from page to page. There are some quite detailed guides on engine/synth usage that were sort of buried before.

4 Likes

Is it OK to document stuff not yet in Oram in the wiki? E.g. a driver that landed in Vangelis? Or would that be too confusing for the general public?

Any guidelines?

1 Like

Hi @niels

If I consider myself a member of the general public, I find this very confusing.
Unless, of course, you clearly document it as a future development.

Kind regards,
Hans.

There is a “Testing” documentation im the wiki (link below, section 2):

But I don’t know how exactly it is intended and how it’s related to the Oram guide.

There is a section in the development section called, “Testing Documentation”. The idea is to put docs here that relate to testing (Vangelis) and move / merge into main docs when the features are deployed to stable. We haven’t really done that much.

2 Likes