Documentation for corteza-js

💻 Core Engineering
#1

The corteza-js repository seems to contain js-doc type inline documentation. Is there a public place we can browse this documentation?

I don’t see any reference to it in the official corteza-js docs. Is there a command we can use to easily build the docs?

Thanks!

#2

interested in this too … I don’t expect a detailed explanation of the code but at least the main components of the package and their interactions

#3

Currently, there isn’t anything (apart from what is inside Corteza JS :: Corteza Docs), but you can probably generate your own and share how you’ve done it (in case we decide to incorporate it into our documentation).

#4

Hey @tjerman ,

We could use https://typedoc.org/ to geneate documentation. See the image below.

image
image2438×1306 200 KB

Let me know if corteza would be willing to consider a PR like this and I may work on it.

However, I do notice all arguments are practically generic (key value types). Given that the types are names of the arguments are available, I think it’d make more sense to generate explicit types.

Would corteza be ammenable to a PR like that?

1 Like
#5

That does seem interesting; @darh what do you think?

#6

lgtm. Should probably be part (subpage) of the docs.cortezaproject.org deployment.

#7

Great, I’m a bit busy in the coming weeks, I’ll send an update once I start working on it.

#8

We have a bit of work done on it Corteza JS 2022.9
There are some issues with including it into Antora (what we use for the docs) but they should be resolved fairly soon