Skip to content

Missing documentation #32

Description

@gavento

We need more documentation for InterLab:

  • Add doc-strings for core modules and functions (check as you go through them)
    • actor
    • context
    • lang_models
    • quieries
    • utils
    • ui
    • ext
    • Use Copilot or GPT-4 to improve and format the doc (or generate minimal docs)
  • Generated API docs
    • Choose a doc generator tool (pdoc, sphinx, nedoc, ...?)
    • This may influence the first point
  • Write overview page with
    • All functionality (with images and for discoverability) with links to API docs
    • Links to demo/intro notebooks (that we already have)
  • Write a quickstart document (or just adapt one of the notebooks, but with images and/or videos rather than interactive and needing API keys)

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions