Wiki

[ProbablePrime]

Is your feature request related to a problem? Please describe. A lack of reliable information at a permanent link

Describe the solution you'd like A publicly available Wiki that documents frequently asked questions and other information.

Additional context I'm making this to pre-bake it for when this repo goes public.

[phil-flip]

Do you already have a wiki-provider/-solution in mind, and should it be editable by the community or just read-only?

[ProbablePrime]

• We have a solution in mind, It is up and running and working
• It will be editable by everyone.

[phil-flip]

What software do you guys have in mind, and when will be the go-live date?

[ProbablePrime]

Media Wiki and when it is ready.

[phil-flip]

Seems kinda dated, but alright.

[ProbablePrime]

Mediawiki is very much alive and gets updates everyday. You may be referring to its look and feel which we will be messing with, most likely after launch, So expect the default theme to start.

[ProbablePrime]

Other priorities keep trumping this one unfortunately(https://github.com/Yellow-Dog-Man/Resonite-Issues/blob/main/HOW_WE_PRIORITIZE.md)

My soul burns every day this is not done. I'll keep ya'll up to date.

---

Several things I want in writing though are:

• This is not a technical issue
• This is not a legal issue
• This is just a boots on the ground issue

Additionally setting some expectations for when it launches:

• Do not expect every single thing to be documented on launch, the wiki is an evolving ecosystem of documentation. It will be impossible to make it complete on launch.
• Do not complain if stuff is missing, instead request that we add it(via gh) OR write it yourself
• Do not direct message me spelling mistakes etc, just edit the wiki and fix it.
• Learn WikiText, its easy and KEWL.

[clarjon1]

Is there anything the community can do to help pitch in on this? Eg harvesting and collating info, updating copies of Old Platform docs with new verbiage, digging up / creating useful flexible theme(s)?

[shininghero]

I second clarjon's post. Don't be afraid to let us help. Give us a style guide or sample document, and we can at least offer to fill out some of the component or flux node docs as we go.

[ProbablePrime]

There is also not a content gap, well content isn't the main focus. So I'm not entirely sure what can be done to help until this launches.

After launch of course, we'll need more content though.

[phil-flip]

I think the most important part would be to actually have something running and guidelines what content goes where, as well as how a Wiki Page should look like/what information should always be available. So maaaaybe a few articles would be good to have an Idea what you have in mind.

---

If it wouldn't be already decided on MediaWiki I would suggest a solution based on Git(Hub) and Markdown. That way we don't lose PRs and a unified place to manage code/data on a file level. While I observed an edit history in MediaWiki, I personally prefer the Git way with Markdown. Review as a PR before it gets published. While I understand that it is more work on your end approving PRs, it's a better way to proofread, propose edits and others chip in to improve. On the other hand, monitoring every edit so a funni doesn't happen sounds like more work to me, especially when it is already published/live. EDIT: There is a current and preview feature, but don't know about Discussion. I am also unsure on possible migration paths away from MediaWiki, in case things turn sour, if it is not just a bunch of files. But again just a thought. (I never really worked with MediaWiki, so don't quote me on that stuff above, and I would be interested, if MediaWiki offers something similar or if the file structure can be edited with Markdown/HTML/whatever.) Here are some projects (and many more I can't find rn), that use Git to generate the Wiki. The only real issue I can see happening, is when it comes to pictures and how that is handled and that people don't necessarily know how to use Git. While I respect the decision and in the end we need to move forward to whatever, so we can show progress. But I felt like I need to explain my previous comment further and offer some alternatives to where the Wiki/Documentation is heading towards.

[Banane9]

Thought I just had while reading #937: When the wiki (in whatever shape) is actually there, it would be great if every component / protoflux node / tool / window could have a direct link to the relevant page in one way or another. This could be a typical (i) icon, with some recognizable Resonite styling, of course - either directly on the UI for windows and components, or as a context menu option for tools. Protoflux nodes may get too cluttered with an extra element, so for those it could also be a context menu entry that opens the wiki page for the node type that would currently be spawned.

Anyways, the reason I'm mentioning it is, that this would become very easy to implement, if the pages just used the (full) name of the component type for their url, so generating the correct link would be trivial to do.

[Merith-TK]

The

I think the most important part would be to actually have something running and guidelines what content goes where, as well as how a Wiki Page should look like/what information should always be available. So maaaaybe a few articles would be good to have an Idea what you have in mind.

If it wouldn't be already decided on MediaWiki I would suggest a solution based on Git(Hub) and Markdown. That way we don't lose PRs and a unified place to manage code/data on a file level. While I observed an edit history in MediaWiki, I personally prefer the Git way with Markdown. Review as a PR before it gets published. While I understand that it is more work on your end approving PRs, it's a better way to proofread, propose edits and others chip in to improve. ~On the other hand, monitoring every edit so a funni doesn't happen sounds like more work to me, especially when it is already published/live.~ EDIT: There is a current and preview feature, but don't know about Discussion. I am also unsure on possible migration paths away from MediaWiki, in case things turn sour, if it is not just a bunch of files. But again just a thought. (I never really worked with MediaWiki, so don't quote me on that stuff above, and I would be interested, if MediaWiki offers something similar or if the file structure can be edited with Markdown/HTML/whatever.) Here are some projects (and many more I can't find rn), that use Git to generate the Wiki. The only real issue I can see happening, is when it comes to pictures and how that is handled and that people don't necessarily know how to use Git. While I respect the decision and in the end we need to move forward to whatever, so we can show progress. But I felt like I need to explain my previous comment further and offer some alternatives to where the Wiki/Documentation is heading towards.

While I agree with this, github markdown is not without its drawbacks. namely extra steps required in order to update the wiki

alot of the time these pages use what are called "Static Site Generators", they take markdown (or other markup languages) and dynamically "compile" the markdown into user readable HTML. Which requires not only pulling the latest changes, but also pushing the updated website,

Media Wiki is, mostly automated outside of maybe adding an review setting

[Banane9]

alot of the time these pages use what are called "Static Site Generators", they take markdown (or other markup languages) and dynamically "compile" the markdown into user readable HTML. Which requires not only pulling the latest changes, but also pushing the updated website,

That can easily be automated with actions and could (theoretically) even be hosted on GitHub directly using pages. The prime benefit is also, that the information isn't siloed away into some platform but available as text that could directly be read and edited if necessary. See this interesting video on the topic: https://www.youtube.com/watch?v=WgV6M1LyfNY

[phil-flip]

Manual deployment would be way too much work. So I wouldn't have set up anything else other than GitHub Actions. Amazing Video, I have to watch them more.

[ProbablePrime]

Lets focus on the current solution here rather than discussing the intricacies of static site generators please.

[phil-flip]

Marry late Christmas. So you are definitely going to settle for MediaWiki, or what do you mean with “current solution”?

[clarjon1]

As shown below, Prime already answered about it being mediawiki in response to your query on oct 31. The current solution is MediaWiki, which is running in a staging environment currently only accessible to the YDMS team, which will be made publicly available when they feel it's at a state releasable to the public.

[phil-flip]

Alright, I was hoping some reconsideration. But I guess not.

[Lexevolution]

There now seems to be no thorough FrooxEngine related dcumentation on any sites (be it first or third party). What could we as a community do to make the wiki higher priority?

[Frooxius]

I don't think there is super much that can be done from community side right now, because it's already pretty high priority on our end, but it keeps getting pushed back by other higher priority items, that we needed to be tackled in time (for example GDPR related work, resolving server/relay issues and so on).

It's mostly just work-bandwidth issue on our end, with a bunch of post-launch problems and issues that need to be sorted out. I know it sucks, but it'll get sorted out in time.

[ProbablePrime]

I have an update,

We should be ready by the 15th, likely much before that but hey here's a date.

[ProbablePrime]

Does anyone have any requested mediawiki plugins? I'm going through plugin operations today for some security things.

[JackTheFoxOtter]

Does anyone have any requested mediawiki plugins? I'm going through plugin operations today for some security things.

The one that allows you to access PDF versions of wiki pages through a direct URL, now that we have native PDF viewing ability.

[DoubleStyx]

Does anyone have any requested mediawiki plugins? I'm going through plugin operations today for some security things.

Maybe the Math extension, for rendering LaTeX in-line?

https://m.mediawiki.org/wiki/Extension:Math

[TisFoolish]

Maybe the Discord extension with a channel to follow wiki edits?

https://m.mediawiki.org/wiki/Extension:Discord

[lxw404]

Mermaid allows you to render graphs/charts/UML diagrams with minimal syntax which could be useful:

https://www.mediawiki.org/wiki/Extension:Mermaid

[Lexevolution]

Here's a few that are bundled with MediaWiki that I'd like to see enabled:

• Cite (Allows footnote citations)
• Math (Allows math notation)
• Syntax Highlight (Colours code blocks to show programming language syntax)
• VisualEditor (Allows a much easier experience editing a wiki page, using a WYSIWYG style editor)
• WikiEditor (Adds some features to the default wiki editor to allow for easier formatting)
• CategoryTree (Adds a tree view for wiki page categories. Might be helpful in the future)

For @JackTheFoxOtter's suggestion, ElectronPdfService is the one used and maintained by Wikimedia, and would provide the same functionality as Wikipedia's version.

MobileFrontend seems good, to make wiki pages easier to read on mobile devices AdvancedSearch could be good for the complex nature of Resonite

[ProbablePrime]

Would cover Cite, Visual Editor, Category tree.

I'll be working on:

• Math
• Syntax Highlight
• PDFs
• Discord
• Advanced Search

[ProbablePrime]

[ProbablePrime]

PDF is going to have to wait, it is a complex extension. I don't know why it needs to be though :(

[ProbablePrime]

Ok we got PDF's up and running, they're a bit ugly and images dont work right now but we'll work on that after launch. I used: https://www.mediawiki.org/wiki/Extension:Mpdf instead, which also required some updates due to our PHP version which will go in: https://github.com/Yellow-Dog-Man/mediawiki-extensions-Mpdf

At some point i'll make images work, but very complicated. The original PDF extension requires a REST server AND an Electron Renderer server to be created and maintained, so Mpdf sounded better.

We can revisit the pdf thing later. This has taken hours.

[ProbablePrime]

Ok That's extensions done, Thanks!

[ProbablePrime]

https://wiki.resonite.com now launched.