Skip to content

Add a proper docs on how to get started #398

@demianeen-minimal

Description

@demianeen-minimal

Pre-checks

What problem does this solve?

The docs really just explain how to get the Clawith installed and running. Not how to actually get started.

For example:

  1. Where do the Clawith sits architecturally near the OpenClaw. It is a proxy? No deployment diagram, or just what runs where
  2. Does it use my existing OpenClaw instance? Does it run it? I can't find it after docker compose ps, but how does it accesses ai agents then?
  3. No setup flow for the external OpenClaw path. After ai have read your source code it said that there is a way to use external openclaw, but again, nothing in the docs
  4. What do I do once I actually install the app. There is a doc called "https://www.clawith.ai/docs/guides/agent-creation" or explanation of certain concepts of certain features. But again, most of those really explain what it is. No how to use it, no example nothing
  5. No explanation of model config ownership (Why is it asking for api key setup if I already have OpenClaw configured with codex/claude)
  6. Naming is too branded, not enough plain English. It is likely better to have 2-3 words that actually explain something, rather than having a single word that doesn't really explain a thing (Aware = autonomous task/attention system, Pulse = trigger engine, Plaza = shared activity feed / org knowledge feed)
  7. Security?
    ... probably way more. I just spend couple of hours speaking with openclaw on my VPS

I needed AI to read source code for me to understand anything honestly

Also, in app docs are clearly ai generated and clearly weren't checked by human. For example, 90% of all steps for setting up Slack could've being just having a manifest content that user can copy and paste when creating slack app. Just look how openclaw did it. They did it way better. Also, after doing all of the steps, I still couldn't get the app working. I am not an expert in creating slack apps, so having a nice guide would be appreciated. Openclaw worked first time in 5 mins

Proposed solution

Docs?

I don't mind helping writing those, but I would need help from someone to explain how all of this actually works

Willing to contribute?

  • I'd be interested in working on this.

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions