DSC icon indicating copy to clipboard operation
DSC copied to clipboard

Add user-defined function reference documentation

Open Gijsreyn opened this issue 3 months ago • 1 comments

PR Summary

This pull request adds reference documentation on how to use user-defined functions.

PR Context

Gijsreyn avatar Sep 26 '25 04:09 Gijsreyn

Thanks for another great submission, @Gijsreyn!

Thinking on this though, I believe we probably need to get the schema source defined first and then define reference documentation. I've been thinking about the overall structure and probably we need to do something like this:

.
├── docs/
│   ├── concepts/
│   │   └── config/
│   │       └── custom-functions/
│   │           ├── index.md (overview)
│   │           ├── defining.md
│   │           └── using.md
│   └── reference/
│       └── schema/
│           └── config/
│               └── functions/
│                   └── custom/
│                       ├── index.md (overview, usage, array)
│                       ├── definition.md (member object definition)
│                       ├── parameters.md (parameter definition)
│                       └── output.md (output definition)
└── schemas/
    └── src/
        └── config/
            └── document/
                └── document.functions.yaml

And prioritize (maybe across multiple PRs) schema -> reference -> concepts.

This structure would also allow us to break out the definition a bit, which would enable us to define the schema types and so on for every subproperty under an appropriate section heading (instead of nested lists without metadata, like we have here). That's also very helpful for deeplinking to relevant sections.

michaeltlombardi avatar Sep 29 '25 14:09 michaeltlombardi