Skip to content

docs: streamline onboarding docs and add compact LLM skill#11

Merged
DxTa merged 3 commits intomainfrom
docs/compact-docs-llm-skill
Feb 11, 2026
Merged

docs: streamline onboarding docs and add compact LLM skill#11
DxTa merged 3 commits intomainfrom
docs/compact-docs-llm-skill

Conversation

@DxTa
Copy link
Owner

@DxTa DxTa commented Feb 11, 2026

Summary

  • Rewrite markdown docs to compact, onboarding-first guides and align wording with current CLI behavior.
  • Add skills/sia-code/SKILL.md as a reusable compact skill that users can copy into their LLM CLI setup.
  • Add docs/LLM_CLI_INTEGRATION.md and update README.md with short copy-and-load integration instructions.

Verification

  • pkgx python -m sia_code.cli --help
  • pkgx python -m sia_code.cli search --help
  • pkgx python -m sia_code.cli memory --help
  • Python markdown link check script (all repo *.md local links resolved)

🤖 Generated with Claude Code

Copy link

@chatgpt-codex-connector chatgpt-codex-connector bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 689994f1bc

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".


```bash
# 1) verify index health
uvx sia-code status

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Initialize before checking status in agent session flow

Running uvx sia-code status as the first step fails with a non-zero exit code in fresh repositories because status calls require_initialized() in sia_code/cli.py and exits when .sia-code/ does not exist. In agent automation contexts that stop on command failure, this prevents the later init/index steps in this workflow from ever executing, so the recommended sequence should start with initialization (or explicitly handle the expected failure).

Useful? React with 👍 / 👎.

@DxTa DxTa merged commit 7683654 into main Feb 11, 2026
14 checks passed
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