This repository has agent-oriented documentation under the openwiki/
directory. When working in this repository, always read the OpenWiki
quickstart first, then follow its links to the relevant architecture,
workflow, domain, operation, and testing notes.
Start here: openwiki/quickstart.md.
It links to:
openwiki/architecture.md-- module boundaries, runtime topology, data flow.openwiki/workflows.md-- publish, capture, comment, cookie refresh loops.openwiki/domain.md-- account, channel, note, topic, template, metrics, event.openwiki/operations.md-- install, run, monitor, recover.openwiki/integrations.md-- Xiaohongshu, Douyin, LLM providers, cookies, proxy.openwiki/testing.md-- test layout, conventions, how to add a test.openwiki/source-map.md-- concrete file / folder index.
The wiki is regenerated by the openwiki --update CLI tool
(https://github.com/langchain-ai/openwiki) on a nightly schedule via
the .github/workflows/openwiki-update.yml workflow.
-
Scope. Only
xiaohongshu-saas/,web/,packages/,installer/,scripts/,docs/,openwiki/,.github/, and the rootREADME.md/CHANGELOG.md/FAQ.md/SECURITY.mdare in scope. Directories such asdata-lakehouse/,donor-*,uml-p-screener/,vnpy/,zhilian/,liepin/,qcc/,li_s_additives/,front/,reports/,memory/,ditiediantu/are unrelated experiments and must not be edited as part of normal work. -
Never commit cookies. They live under
xiaohongshu-saas/data/cookies/and are git-ignored. -
Xiaohongshu publisher is fragile. Read
openwiki/integrations.mdbefore changingapp/channels/xiaohongshu/. Rate limits and cookie rotation matter. -
Dependency bumps. Never bump a major version without asking and updating
xiaohongshu-saas/requirements.txt. -
Tests. Touching the backend?
pytest -qfromxiaohongshu-saas/must stay green. Touchingweb/?npm run lint && npm run testmust stay green. -
Releases. Version bumps happen in
installer/build.ps1. The MSI artifact is uploaded to the matching GitHub Release tag.