Teknium
|
972482e28e
|
docs: guides section overhaul — fix existing + add 3 new tutorials (#5735)
* docs: fix guides section — sidebar ordering, broken links, position conflicts
- Add local-llm-on-mac.md to sidebars.ts (was missing after salvage PR)
- Reorder sidebar: tips first, then local LLM guide, then tutorials
- Fix 10 broken links in team-telegram-assistant.md (missing /docs/ prefix)
- Fix relative link in migrate-from-openclaw.md
- Fix installation link pointing to learning-path instead of installation
- Renumber all sidebar_position values to eliminate conflicts and match
the explicit sidebars.ts ordering
* docs: add 3 new guides — cron automation, skills, delegation
New tutorial-style guides covering core features:
- automate-with-cron.md (261 lines): 5 real-world patterns — website
monitoring with scripts, weekly reports, GitHub watchers, data
collection pipelines, multi-skill workflows. Covers [SILENT] trick,
delivery targets, job management.
- work-with-skills.md (268 lines): End-to-end skill workflow — finding,
installing from Hub, configuring, creating from scratch with reference
files, per-platform management, skills vs memory comparison.
- delegation-patterns.md (239 lines): 5 patterns — parallel research,
code review, alternative comparison, multi-file refactoring,
gather-then-analyze (execute_code + delegate). Covers the context
problem, toolset selection, constraints.
Added all three to sidebars.ts in the Guides & Tutorials section.
|
2026-04-06 22:02:47 -07:00 |
|
teknium1
|
31b84213e4
|
docs: add Guides & Tutorials section, restructure sidebar
New documentation pages (1,823 lines):
- getting-started/learning-path.md: 3-tier learning path table
(beginner/intermediate/advanced) + use-case-based navigation
- guides/tips.md: Tips & Best Practices quick-wins collection
covering prompting, CLI power user tips, context files, memory,
performance/cost, messaging, and security
- guides/daily-briefing-bot.md: End-to-end tutorial building an
automated daily news briefing with cron + web search + messaging
- guides/team-telegram-assistant.md: Full walkthrough setting up
a team Telegram bot with BotFather, gateway, DM pairing, and
production deployment
- guides/python-library.md: Guide to using AIAgent as a Python
library — basic usage, multi-turn conversations, toolset config,
trajectories, custom prompts, and integration examples (FastAPI,
Discord bot, CI/CD)
- reference/faq.md: Centralized FAQ (8 questions) + troubleshooting
guide (6 categories, 18 specific issues) with problem/cause/solution
format
Sidebar restructure:
- Added 'Guides & Tutorials' as new top-level section
- Reorganized flat Features list (17 items) into 5 subcategories:
Core Features, Automation, Web & Media, Integrations, Advanced
- Added FAQ to Reference section
- Updated index.md quick links table
Docusaurus build verified clean.
|
2026-03-08 19:37:34 -07:00 |
|