Start with a question
These notes answer recurring questions about using Zhin and point to sources you can check today. If you are new, begin with the first Bot. If you already have a project, go straight to the part that is blocking you.
Getting started
- How do I know the first Bot really works? Go from a new project to a
/helloreply in Sandbox. - For where settings belong, see Configuration. For a path through the product, see Solutions.
Writing plugins
- Should a capability live in a convention directory or
plugin.ts? Decide based on shared resources and lifecycle needs. - For exact file names, see Convention Directories.
Messages and adapters
- Where do messages enter and leave? Locate middleware, commands, and replies in the pipeline.
- For a real platform, start with the adapter index and check its configuration and limits.
AI and Tools
- Why is a Tool missing or waiting for approval? Check installation, access, discovery, and execution separately.
- If AI is not enabled yet, start with AI setup. An IM Bot does not need a model key.
Operations
- The process started; is the Bot usable? Check liveness, runtime readiness, and real platform delivery.
- For deployment and diagnosis, see Production Deployment and Troubleshooting.
Source archive
The 29 original Cubic Wiki articles, Chinese translations, and known corrections remain at their existing URLs. Use them to find leads; use current documentation and source code to confirm runtime behavior.