Skip to content

docs: update Python developer docs for arkitekt-next API#27

Open
jhnnsrs wants to merge 1 commit into
mainfrom
docs/arkitekt-next-api-update
Open

docs: update Python developer docs for arkitekt-next API#27
jhnnsrs wants to merge 1 commit into
mainfrom
docs/arkitekt-next-api-update

Conversation

@jhnnsrs

@jhnnsrs jhnnsrs commented Jun 3, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Migrates all Python developer documentation from the legacy arkitekt package to the new arkitekt-next package
  • Updates CLI commands from arkitektarkitekt-next and arkitekt portarkitekt-next kabinet
  • Updates all import paths: from arkitekt importfrom arkitekt_next import
  • Replaces the old mikro type RepresentationFragment with Image and from_xarray with from_array_like (from mikro_next.api.schema)
  • Adds a new "App Lifecycle Hooks" section to plugin/more.mdx documenting @startup, @background, @state, and @context decorators

Files changed

  • installation.mdx — new package name, CLI, and both classic/plugin code examples
  • classical/index.mdx, classical/usage.mdx, classical/read-write.md — updated imports and function names
  • plugin/index.mdx, plugin/usage.mdx, plugin/more.mdx — updated imports, types, CLI commands; added lifecycle hooks section
  • plugin/build.mdxarkitekt portarkitekt-next kabinet
  • graphql.mdx — updated CLI commands

Test plan

  • Verify the docs build without errors (yarn build)
  • Spot-check code examples against the installed arkitekt-next==0.9.1 and mikro-next==0.2.0 packages

🤖 Generated with Claude Code

Migrate all Python developer documentation from the legacy `arkitekt`
package to the new `arkitekt-next` package.

Key changes:
- Install: `arkitekt[all]` → `arkitekt-next[all]`
- CLI: `arkitekt` → `arkitekt-next`; `arkitekt port` → `arkitekt-next kabinet`
- Imports: `from arkitekt import` → `from arkitekt_next import`
- Mikro type: `RepresentationFragment` → `Image`
- Mikro upload fn: `from_xarray` → `from_array_like`
- Mikro import path: `mikro.api.schema` → `mikro_next.api.schema`
- Added new "App Lifecycle Hooks" section covering @startup, @background,
  @State, and @context decorators

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant