How do we want the API to look like #24
Roshanjossey
started this conversation in
Ideas
Replies: 0 comments
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
-
Let's add details about design inspirations and developer experience we want to achieve.
Related question: How do we automate documentation of API when we continue building jinajs?
I think we should use Typedoc for this.
The most important place where we need documentation is inside IDE.
https://blog.bitsrc.io/documenting-your-typescript-projects-there-are-options-da7c8c4ec554
We would also benefit from having it in Readme and also a dedicated web page. (Maybe part of docs.jina.ai)
Beta Was this translation helpful? Give feedback.
All reactions