Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add developer/API documentation #27

Closed
brandomr opened this issue Nov 17, 2023 · 0 comments
Closed

Add developer/API documentation #27

brandomr opened this issue Nov 17, 2023 · 0 comments
Assignees

Comments

@brandomr
Copy link
Contributor

On the developer side:

  1. Define what is a codeset and describe how to create a new one
  2. Define a toolset and describe how to create a new one
  3. Describe how to add a subkernel
  4. Describe how environments/julia is used in comparison to a codeset or subkernel
  5. Describe how to add a custom kernel action (insofar as it isn't covered above)
  6. Add existing architecture diagram from excalidraw to docs

On the API side:

  1. Define and describe allowable requests and custom kernel actions
  2. Provide example requests for various usages and example responses
  3. Discuss how the Developer UI can be utilized for testing/extension/etc.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

No branches or pull requests

2 participants