Skip to content

Update/readme#9

Merged
LarFii merged 2 commits intodevfrom
update/readme
Feb 10, 2026
Merged

Update/readme#9
LarFii merged 2 commits intodevfrom
update/readme

Conversation

@LarFii
Copy link
Contributor

@LarFii LarFii commented Feb 10, 2026

📋 Change type

Select the type of this PR:

  • ✨ Feature (feature)
  • 🐛 Bug fix (bugfix)
  • 🔧 Refactor (refactor)
  • 📝 Docs (docs)
  • 🎨 Style (style)
  • 🧪 Tests (test)
  • 🔨 Chore / tooling (chore)

📝 Description

What changed

Comprehensive documentation overhaul across three files:

README.md

  • Added 📰 News section at the top for release announcements
  • Added nanobot-demo.gif as hero content below Features
  • Added full 🧠 AI Features section: TAP Completion, Agent System (MainAgent + SubAgent + ReAct loop), Deep Research pipeline, Unified Tool Layer
  • Added 📱 nanobot section: architecture, 20-tool overview, session management, link to deployment guide
  • Replaced all ASCII architecture diagrams with actual images (Architecture.png, AIServer.png, MainAgent.png, DeepResearch.png, nanobot.png)
  • Updated service architecture table (6 services), project structure, tech stack
  • Expanded environment variables (grouped by Core / AI / nanobot / Storage / Optional)
  • Added Contributors widget (contrib.rocks) and Star History chart
  • Added emoji icons throughout for visual appeal

env.example.oss

  • Added LLM_MODEL (default: google/gemini-3-flash-preview)
  • Added EMBEDDING_MODEL (default: text-embedding-3-small)
  • Added commented REDIS_URL with Docker vs host instructions
  • Added NANOBOT__AGENTS__DEFAULTS__MODEL override option
  • Improved section organization and inline comments

nanobot/DEPLOYMENT.md

  • Expanded agent tool list from 6 to 20, grouped by category (Core, File, Project, Version, Import, Utility)
  • Added litewrite_agent tool deep-dive (session management, Web UI visibility, modes, 5min timeout, call chain)
  • Updated Internal API endpoints table with all missing endpoints (versions, import, agent/run, file CRUD)
  • Updated project structure tree to match actual codebase
  • Added Telegram troubleshooting and "Project not found" (missing user ID) fix

Context

The existing documentation was significantly out of date — it had no mention of AI architecture details, nanobot integration, or many environment variables that were added in recent releases. This PR brings all three documentation files in sync with the current codebase.

Related issue(s)

N/A


🖼️ Screenshots / demo

New architecture images added:

Image Description
public/Architecture.png Updated overall service architecture
public/AIServer.png AI Server internal structure
public/MainAgent.png MainAgent + SubAgent orchestration
public/DeepResearch.png Deep Research pipeline
public/nanobot.png nanobot integration architecture
public/screenshots/nanobot-demo.gif nanobot Telegram interaction demo

✅ Test checklist

Please confirm:

  • Tested locally
  • Rebased/merged the latest dev
  • No ESLint or TypeScript errors
  • New code has necessary comments
  • Translation files updated (if UI copy changed)
  • Tested dark/light theme compatibility (if styling changed)
  • Database changes synced to prisma/schema.prisma (if applicable)

This is a docs-only PR — no code changes, no runtime impact.


📌 Notes

  • The nanobot-demo.gif is ~50MB. Consider whether it should be hosted externally (e.g. GitHub releases or a CDN) to avoid bloating the repo.
  • All architecture images are designed by the team and placed in public/ for direct README rendering.
  • env.example.oss changes are backward-compatible — only adds new variables with sensible defaults.

👀 Review focus

  • README.md structure and flow — does the ordering make sense for new visitors?
  • Accuracy of AI Features descriptions vs actual implementation
  • nanobot tool list completeness (20 tools documented)
  • env.example.oss variable names and defaults

LarFii and others added 2 commits February 10, 2026 13:41
README.md:
- Add News section for release announcements
- Add nanobot demo GIF placeholder as hero content
- Add AI Features section (TAP, Agent system, Deep Research architecture)
- Add nanobot section with architecture and 20-tool overview
- Add emoji icons to all sections and feature tables
- Update service architecture table, project structure, tech stack
- Expand environment variables with AI/nanobot/storage groups

env.example.oss:
- Add LLM_MODEL, EMBEDDING_MODEL, REDIS_URL
- Add nanobot model override option
- Improve section organization and comments

nanobot/DEPLOYMENT.md:
- Expand tool list from 6 to 20 (grouped by category)
- Add litewrite_agent deep-dive (sessions, modes, timeout)
- Update Internal API endpoints (versions, import, agent/run, file CRUD)
- Update project structure tree
- Add Telegram and "Project not found" troubleshooting

Co-authored-by: Cursor <[email protected]>
…lish

- Replace all ASCII architecture diagrams with actual images
  (Architecture.png, AIServer.png, MainAgent.png, DeepResearch.png, nanobot.png)
- Add nanobot-demo.gif moved to below Features as hero content
- Simplify News section to bullet list with actual dates
- Add Contributors section with contrib.rocks widget
- Add Star History chart with dark/light theme support
- Add visitor badge and updated footer
- Remove License section (covered by badge), streamline ending

Co-authored-by: Cursor <[email protected]>
@LarFii LarFii merged commit 0703962 into dev Feb 10, 2026
3 checks passed
@LarFii LarFii deleted the update/readme branch February 10, 2026 06:38
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