Skip to content

docs(tarko): restructure cli documentation into separate sections - #1610

Merged
ulivz merged 7 commits into
mainfrom
docs/restructure-cli-documentation
Sep 21, 2025
Merged

ulivz merged 7 commits into
mainfrom
docs/restructure-cli-documentation

Conversation

@ulivz

@ulivz ulivz commented Sep 21, 2025 •

Copy link
Copy Markdown
Member

Summary

Restructured CLI documentation into proper sections with clear separation of concerns:

New Structure:

  • /guide/cli/ - Complete CLI reference aligned with @tarko/agent-cli README
  • /guide/deployment/cli.mdx - Production deployment strategies only

Checklist

  • Added or updated necessary tests (Optional).
  • Updated documentation to align with changes (Optional).
  • Verified no breaking changes, or prepared solutions for any occurring breaking changes (Optional).
  • My change does not involve the above items.

Separate CLI documentation into proper sections:
- /guide/cli/ - Complete CLI reference aligned with agent-cli README
- /guide/deployment/cli.mdx - Production deployment strategies

Added comprehensive CLI documentation:
- Overview: Introduction and core concepts
- Commands: Complete command reference with all options
- Configuration: All configuration formats and options
- Built-in Agents: Using pre-built agents

Updated deployment documentation:
- Focus on production deployment strategies
- Docker, Kubernetes, PM2 deployment examples
- Load balancing, monitoring, CI/CD integration
- Cross-reference to CLI documentation

Both English and Chinese versions included.
@netlify

netlify Bot commented Sep 21, 2025 •

Copy link
Copy Markdown

✅ Deploy Preview for agent-tars-docs ready!

Name Link
🔨 Latest commit e2c48a0
🔍 Latest deploy log https://app.netlify.com/projects/agent-tars-docs/deploys/68d023aff43aca0008377de1
😎 Deploy Preview https://deploy-preview-1610--agent-tars-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@netlify

netlify Bot commented Sep 21, 2025 •

Copy link
Copy Markdown

✅ Deploy Preview for tarko ready!

Name Link
🔨 Latest commit e2c48a0
🔍 Latest deploy log https://app.netlify.com/projects/tarko/deploys/68d023af9818140008d19a1c
😎 Deploy Preview https://deploy-preview-1610--tarko.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

- Remove AI-generated bloat and fake APIs
- Focus on actual functionality and usage
- Add architecture diagram with Mermaid
- Keep content concise and user-focused
- Remove non-existent options like --cache-enabled, --metrics-enabled, --profile
- Remove fake processInput method examples
- Maintain consistency between EN/ZH versions
- Remove non-existent config options like ui, logging, metrics, ssl, rateLimit
- Remove fake API endpoints and validation commands
- Keep only real configuration options from actual interfaces
- Focus on practical usage patterns
- Remove verbose AI-generated explanations
- Maintain consistency between EN/ZH versions
- Base all examples on actual AgentAppConfig interface
- Replace non-existent ConsoleInterceptor with actual debug options
- Keep content focused on real CLI capabilities
- Maintain consistency between EN/ZH versions
- Fix rspress build error for unknown meta item type
- Update both EN and ZH meta.json files
- Use 'file' type instead of 'page' for consistency
@ulivz
ulivz merged commit 7c1f576 into main Sep 21, 2025
10 checks passed
@ulivz
ulivz deleted the docs/restructure-cli-documentation branch September 21, 2025 16:17
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