Maybe add a Verse API reference?

[SaSteMi]

I noticed that in the list of "Built-in Functions" in the concept index some stuff (e. g. /SpatialMath, /SceneGraph) is missing and was wondering whether there were plans to add documentation regarding that in the future.

[SaSteMi]

Oh I could also make draft if no professional is working on it, just lmk

[sprintermax]

The book is about the Verse language aspects only. It does not include external modules such as APIs and features added from any other tools/services/environment usages...

The SpatialMath and SceneGraph modules are not built in on the verse base language, but instead modules for usage such as on the Unreal Engine, 3D Math and contexts such as UEFN, the same with the /Fortnite.com module.

The book focus on explaining the language concepts, details and design behind it. It may have some example codes for easier understanding of these concepts and how the language works, but it is a Language Documentation and not an API Documentation...

In the future we may get a proper API Docs with all functions descriptions, params, usages and that one would be ok to include the modules that are also provided by epic for UE/SpatialMath/Fortnite. (In fact, I think we can already suggest or even start a proposal to start making one if we want to contribute to it!)

Later, we can even consider having a wiki, with real usages, example codes and tutorials from the community to help learning :P

[sprintermax]

I believe that for starting an api docs, would be good to use a subpath of the repo such as /api/docs (since the current /docs is already the language one).
Also keep note that these would be two different things - They are usually not displayed on same page/site (besides the API docs usually being able to refer back to the Language docs for better explaining concepts). You can check some other programming languages for examples of how it is done...

[SaSteMi]

Oh sorry, I didn't think about that distinction, thank you!

That kind of API doc and wiki would be really great! I will try to make a (very primitive) draft when I have some time.

[janvitek]

We need a tool for generating API summaries from the code. I was hoping to get around to writing one, but alas I am distracted.

[sprintermax]

Yeah that feels the best alternative to have. Afaik there is already digest generators so these could be taken into account too

[janvitek]

The official documentation is rather clunky.