HISE Logo Forum
    • Categories
    • Register
    • Login

    Contributing to auto-generated docs

    Scheduled Pinned Locked Moved Documentation
    4 Posts 2 Posters 333 Views
    Loading More Posts
    • Oldest to Newest
    • Newest to Oldest
    • Most Votes
    Reply
    • Reply as topic
    Log in to reply
    This topic has been deleted. Only users with topic management privileges can see it.
    • d.healeyD
      d.healey
      last edited by

      I'm wanting to add a few bits of documentation. Some of the docs have dedicated markdown files, while others are generated from the source code.

      How would I add to an auto-generated part without bloating the source code? Do I just create a new markdown doc with a certain title? Will this override the auto-generated doc or add on to it?

      Libre Wave - Freedom respecting instruments and effects
      My Patreon - HISE tutorials
      YouTube Channel - Public HISE tutorials

      1 Reply Last reply Reply Quote 0
      • d.healeyD
        d.healey
        last edited by

        Bump bump

        Libre Wave - Freedom respecting instruments and effects
        My Patreon - HISE tutorials
        YouTube Channel - Public HISE tutorials

        Christoph HartC 1 Reply Last reply Reply Quote 0
        • Christoph HartC
          Christoph Hart @d.healey
          last edited by

          @d-healey The autogenerated docs are pulled from various sources of information. Do you have a specific example in mind?

          Some are hardcoded in the source code, some are pulled from the scripting API docs and some are parsed from the markdown metadata header (eg. the scriptnode docs).

          d.healeyD 1 Reply Last reply Reply Quote 0
          • d.healeyD
            d.healey @Christoph Hart
            last edited by

            @Christoph-Hart

            Suppose I wanted to add an example, a snippet, and a video link to go along with this function - https://docs.hise.audio/scripting/scripting-api/sampler/index.html#setguiselection

            Libre Wave - Freedom respecting instruments and effects
            My Patreon - HISE tutorials
            YouTube Channel - Public HISE tutorials

            1 Reply Last reply Reply Quote 0
            • First post
              Last post

            44

            Online

            1.7k

            Users

            11.7k

            Topics

            101.9k

            Posts