BTW everyone: Welcome to the Docs!
-
Have a look and check it out:
In the latest
scriptnoderelease, please make sure to try out the shortcut [F1] to directly access the docs in the HISE inhouse documentation. (it even has an inbuild code playground..)The web-docs and the inhouse.docs are directly mirrored.
If you want to contribute please have a short look here:
https://docs.hise.audio/glossary/contributing.htmlThe hise_documentations github repo:
https://github.com/christophhart/hise_documentation/Obviously it's an ongoing process to work on the docs, to fill them up, and making them more precise. So.: If you find a (some) mistake(s) or want to contribute to a page, please don't hesitate to create an issue or a pull-request in the github repo!
But first of all: let's have a little docs unboxing party: :party_popper:
:))Greetings,
d -
Oh this looks very nice. Well done!
-
@Dominik-Mayer Cool man thank a lot! I had a look online yesterday it's really great!
Although I noticed that the TOC disappeared once inside a sub-category, likeUI Component/Plugin Component/Panelfor instance, so it can be tedious to navigate through a long page... -
Looks awesome, congrats! ;)
-
@Dominik-Mayer I successfully pulled the Git doc
Once in Hise, it seems to be synced, but the menu is almost empty
Although when clicking the next button, I land on doc pages, but the menu still displays categories only (not even all as it begins with "HISE Modules")
-
-
Try the latest scriptnode version (I've just pushed the changes), there were a lot of minor issues that are fixed in the documentation system
-
Do you want to read the docs in the browser or contribute? If you just want to read the content, you don't need to checkout the github repo, just follow the instructions to download the doc content from the server. If you do want to contribute though, you need to click on the lock icon on the right to switch from the "compiled" doc content to the actual markdown files. Then you can right click anywhere and select "Edit doc in editor", save the changes and make a pull request :)
-
-
@Christoph-Hart Cool, but it still doesn't work for reading doc only. I just have the
"HISE Modules"menu which doesn't open any content...
When downloading from the server, it seems to download the.datthoughAlso,
F1doesn't work anymore (the Help menu seems to be triggered, but doc panel doesn't show up)latest commit of course
-
Seems like you have a broke content file. Here's how to reset:
- Click on the refresh icon in the doc window (the second icon to the left). It will show a popup. Choose (Update docs from server), press OK. Wait, then it should rebuild the docs from the current content.
-
@Christoph-Hart Thanks Christoph, but unfortunately that's what I'm trying to do from the beginning in fact...
-
Hmm, sounds weird, but I imagined there might be hiccups like this. Can you upload the
Content.datfile in your CachedDocumentation directory, maybe I can see there whats wrong. -
@Christoph-Hart Well, I have something more interesting, I just don't have any
Content.datfile, neither the directory you said...
After refreshing the doc from server, there's a popup saying "everything is up to date" -
It should be in your app data folder, but then again, I need to check this with macOS (but last time I checked it worked).
-
Oups I forgot this one... Here you go:
content.dat.zipI tried to remove the CachedDocumentation directory and try to redownload, but nothing is downloaded and the updating window keeps looping.
-
Hmm, that looks precisely like how it was before I fixed it yesterday. Are you sure you're using the latest commit (https://github.com/christophhart/HISE/commit/93ba484b11a1d28b415fe2228c55c98f2698f94a) ?
-
@Christoph-Hart Alright I'm just a noob with github... I wasn't using the last commit
So downloading the last commit manually did the trick (and fixed all the issues I had today, remember the labels thing)But in my defense (
) Gitkraken tells me the pull is up to date.
Do I need something else than a pull, which is already a fetch+merge? -
No pulling should be fine, no need to merge stuff. But glad that it's resolved - I am compiling HISE on my macbook at the moment, but I think I can skip it then :)
-
@Christoph-Hart Sorry man
Will find a solution for this pull issue then... -
@Christoph-Hart The "Next" button actually does a jump of two ahead in the menu instead of one
-
Thanks ! Can't wait to dig into it this evening. :)
-
Awesome. Really well done. This will be very helpful. Thank you
