Reference Doc (semi-manual).

[marius-baseten]

🚀 What

Gernate truss-chains API reference page

💻 How

• Add many in-code docstrings.
• Use sphinx with autodoc to generate markdown.
• Use a hacky plugin to make the generated markdown nicer in mintlify.
• Manually edit the rest.
• Create a patch file between the generated and edited version for reproduciblity.
• Integrate as snippet in mintlify docs.

🔬 Testing

[squidarth]

should this be exposed in the docs? I feel like add_service and whatnot are all somewhat internal implementation details of the CLI, I don't know if we want to codify/expose these to the outside world in their current form at least.

[marius-baseten]

Yeah, I thought about this too.
The reason why ChainService is at all part of the docs is because it's the return value of the (public API) function deploy_remotely. But some of its methods must/should not be used by users.

It seems to me that this is actually a bit a leaky design and we should ideally have something like an internal ChjainServiceBuilder (with methods like add_service) and then convert that to a public ChainService which only has the methods relevant to users like predict - it would be quite a bit of refactoring work which I don't wanna prioritize right now.

We could as a patchy solution just un-document the methods not intended for public use or keep them, but add in the docstring that they are not intended for end-users.

What do you think is overall best?