HISE Meet Up

[jeffd]

@d-healey
thanks for sharing this everyone

[aaronventure]

Sorry for missing this, I'm fully engaged this week and couldn't find an excuse yesterday to hide in the loo for an hour.

I'd like to add my 2 cents to the docs discussion. Regarding with what's missing, I think there's a number of methods which are obscure and are missing examples. These are easily tackled as they come, someone can just post and then another person can chime in and provide an answer or an example. This ties in to the difficulty of adding to the documentation, because there should be a simpler way to just submit this to the docs. Right now I just make a post in the documentation subforum and hope @Christoph-Hart adds it to the docs while he's waiting for HISE to build or something.

Another point is the search. Here's Kontakt's docs https://www.native-instruments.com/ni-tech-manuals/ksp-manual/en/welcome-to-ksp

If you start typing, it'll immediately filter results and highlight first the matching methods, then methods or topics where the word is mentioned while showing a few lines of context as well. So I would suggest getting the search to this level.

Another option that compliments this further:

I'm playing Frosthaven (have been for a while and it'll take a bit whiler to finish it). It's basically an attempt to pack a tabletop campaign into a boardgame with hard rules that doesn't require a DM. Works great for two people. It's absolutely massive; the rulebook is 80 pages long. Practically a novella. At the end, there's an index with every possible keyword mentioned in the rulebook regarding the game mechanics, sorted alphabetically, and next to each is a list of pages in the rulebook where the keyword is touched on or explained (the pages explaining it are in bold). It works so well for navigating this huge rulebook on the fly. There's a version online and you can see the index here

Frosthaven Rule Book

This is a lightweight, searchable, version of the Frosthaven Rule Book. © 2022 Cephalofair Games, LLC. All Rights Reserved

Frosthaven Rule Book (pikdonker.github.io)

The Kontakt docs I linked above do it with the search results; it shows all the places where the keyword was mentioned. But not everyone (especially someone new to a different part of HISE or HISE in general) knows what to search for. An index like this is easily skimmable and can provide leads very quickly, but can also solidify the lingo for HISE which will also make the forum talk more searchable.

It wouldn't have to link to pages or methods, but if a search like the one for KSP is implemented, clicking on a keyword should immediately pop up a search and the effect should be as if you just got pointed to a page in the rulebook.

This index of keywords is something the community can easily help create and solidify, and then a pass can be made through the docs to make sure it's consistent. This could be a lot less work than rewriting docs because of a paradigm shift or restructuring.

Regarding helping things get up and running more easily, I'll make a post on the weekend or next week to share some of the scripts I have that build different versions of HISE and plug in any preprocessor definitions that are written in a separate text file.

[d.healey]

I think the docs search is something that might benefit from an AI system. Where you could tell the AI I want to do X and it would point you to the relevant documentation pages - and definitely not attempt to write any code for you.

[aaronventure]

@d-healey that, too. there are plenty of tools available for implementing this into your own website as well. It could get expensive: I don't know the exact pricing for similar services from AWS and the like.

You already can use the NVIDIA ChatRTX on Windows where you download an open source LLM your computer can handle, upload the documents that you want to talk about (HISE docs repo) and then just chat to it.

There's also https://anythingllm.com/ but I haven't tried it.

[d.healey]

Should we arrange a meet up for the end of this month? Christoph will be back then too. :)

[HISEnberg]

@d-healey Yes would love too!

[griffinboy]

@d-healey

Would like that!

[Lindon]

@d-healey yep all in.

[Christoph Hart]

I‘m back on Friday so let‘s doodle that stuff.

[Morphoice]

@d-healey I'm all in!

[Oli Ullmann]

@d-healey
Great idea! :-)

[VirtualVirgin]

@d-healey
May I join?

[d.healey]

@VirtualVirgin Of course, everyone is welcome.

[d.healey]

Think I've done this correctly....

Doodle

(doodle.com)

[d.healey]

If anyone wants to propose discussion topics for the meeting please do. A couple of suggestions: Onnx, Christoph's HISE goals for 2025.

[griffinboy]

@d-healey

Did we do one on broadcasters already?

[Matt_SF]

@griffinboy said in HISE Meet Up:

@d-healey

Did we do one on broadcasters already?

+1 for broadcasters.
I'm in!

[d.healey]

@griffinboy I've got some broadcaster feature requests :) I have more tutorials planned too.

[Lindon]

@d-healey said in HISE Meet Up:

If anyone wants to propose discussion topics for the meeting please do. A couple of suggestions: Onnx, Christoph's HISE goals for 2025.

I'd like us to discuss the priority of bug fixes...what we think needs to be fixed first, second etc. NOT specific bugs but the category of bug. Here's my suggestion:

1. Bugs that cause existing functionality to no longer work - so it worked in a previous version - now it doesn't.
2. Bugs that cause proposed functionality to not work - so its never worked - but we'd all really like to see it fixed
3. New Stuff.

..and can we (if say we agreed to these categories) get bugs annotated in GitHub with their category.

[d.healey]

@Lindon That sounds like it will be very beneficial, so the first category are regressions and the second is failed implementation.