-
Notifications
You must be signed in to change notification settings - Fork 19
[docs] guides #300
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[docs] guides #300
Conversation
|
install seems to work fine, yes |
tremblap
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
this looks great and compiles and links work. I was surprised of the location of the files (docs/vignettes/flucoma) but I reckon that is the right place since that works ;)
Yeah its a little unusual but I think, from what I can tell, that folder there dictates the "module" that the vignette belongs to. HIRT does this and so does a lot of the internal packaging system so that you can have vignettes with the same name across different parts of the docs... hard to tell as none of this is documented though. |
* fluid.stats typo * ammend references to lowercase beatRemember * update beat to Beat * [fix] various beta7 discovery issues (#280) * cleanup help/patchers/js/jsui distinction * cleanup demosound * use float instead of integer * higher fftsize for low pitch analysis * remove bufresize * higher maximums for modulation * resize mfcc patcher * give size to fluid.stats * add printing to left outlet now that its usd * fluid.stats~ to fluid.stats * null sum first tab of bufnmf * fix numchroma * update plotter instances with @border 0 (#278) * [docs] add argument jsui to relevant objects docs (#284) * remove 2 help files wile we are here * update all help files with instantiation args * remove floating spectroscope~ * numderivs rework * make it play stereo on multichannel example * fix expanded dataset tab * norm + robscal: fix dangling refs to std * label set typo, fixes #291 * fixes #290 * update kdtree analysis explanation * add pointsizescale in to kdtree help file * ammend language in bufthreaddemo~ * update to use FMTriDist-M.wav * sign nightlies * use output_type * sign releases too and update cruft * make wildcards consistent * remove baked in prefix * add tab to demonstrate transformjoin in practice * remove merging mischaracterisation * [docs] pre-release help file checks (#299) * update numbers on fluid.pitch~ tabs * add audio on text to first tab * update learn link * update buf2list with proper header * fix multitude of style issues and clarity of patching * fix bogus numbering * cosmetic * cleanup annotations * cosmetic * fix second tab * cosmetic * update how fluid.plotter drags without border * update poorly numbered steps * update second tab * cosmetic * fix numbering * cosmetic * cosmetic * cosmetic * cosmetic * cosmetic * cosmetic * cosmetic * numbering * cosmetic * add bang to output to demonstrate finishing * mc tab * add header * update numbering * interp -> interpolation * add bang to processing done * cosmetic * audio on numbering * add higher maxfiltersize * cosmetic * cosmetic * cleanup * fix multichannel tab * remove auto-bang * numbering issue * update musical example * many cosmetic issues * cosmetic * cosmetic * fix ordering issue * fix numbering * numbering and cosmetics * minimise size of patcher * cosmetic * neaten header * neaten header * no border on scalercomparison * save with subpatchers closed * add select tab * autosize 0 * cleanup style * cosmetic pruning * add select tab * fix ordering of select * fix missing arg to select * add select * reuse source selector * add select tab * refactor under the hood tab * add missing references * remove superfluous bang * digests for messages * use new header * use new header * remove processsegments and segmentcorpus * update decomposition blocking to no longer be broken * fix the olencki file as the source * speed limit and pointsize scale the comparison * enforce concurrency of jobs * remove crufty examples * remove bufview * cleanup as much as is humanly possible * use waveform view * fix 8c example * update and remove examples * CMake: Install Max index json files for object lookup (#301) * set font sizes to 13 * 13 font size * [docs] guides (#300) * add buffer management example * add guide entry * finish text * aesthetic * how did that get there... * update example * add link to buffer management guide as a new tab * add dsinterface tab to all dataset processors * install vignettes to the docs folder * install to docs folder (not vignettes of docs) * get correct combination of magic words * add dsinterface and dslink patchers * update name to be more semantic * adjust font sizes * normalise font to 13 * cosmetic * MaxWrapper: ensure autonamed model objects can be referred to (#297) * rename bufcompose example to be consistent with vignette type * add vignette for bufcompose macros * all jacobs typos * CMake: Actually implement installation bypass switch for internal objects (#303) * Wrapper: Improve inlet assists and rogue inlet on fluid.stats (#302) NMFMorph still a problem * fix bufview * fix pont size scale * empty box to begin with
This adds a guide for automatic
buffer~anddataset~management. This includes a reference entry under "Guides" as well as a patch. Alongside this every buffer~ processor and every dataset~ processor now have a shared tab, that takes them to this patch.I would appreciate your okay on this. I am fairly confident that the content is solid as @weefuzzy already took a glance.
@weefuzzy Would you be able to test the install changes I made to
cmake. They may not be correct but seemed fine my end.