Skip to content

docs: start-here guide for non-technical users + auto-release - #7

Merged
BerryUIKI merged 8 commits into
devfrom
docs/start-here-guide
Aug 4, 2026
Merged

BerryUIKI merged 8 commits into
devfrom
docs/start-here-guide

Conversation

@BerryUIKI

@BerryUIKI BerryUIKI commented Aug 4, 2026 •

Copy link
Copy Markdown
Owner

Summary

READMEs now speak to complete beginners, in all 10 languages. The reviewed zh-CN template has been applied to every language version.

Start-here section (per language)

  • Folder tip: create an axiara-workspace folder to avoid losing files
  • Way 1 (easiest): hand the link to your AI agents — code-block prompt uses git clone, reads AGENTS.md, strictly follows docs/init.md; Git prerequisite noted with an install link
  • Way 2: download from Releases / Download ZIP, unzip, let a local agent guide setup (no-Git path)
  • Check for updates: manual update-check prompt (keeps .data)
  • Developer Quick Start (renamed from Quick Start) kept for developers

Also included

  • AGENTS.md: hard rule — never start quoting/querying before .data/ is initialized
  • README footer note (all languages): instruction for AI agents to read AGENTS.md + docs/init.md
  • .github/workflows/auto-release.yml: on push to main, bumps v0.x.y and creates a GitHub release (source zip/tar.gz auto-attached)
  • PLAN.md: branch-protection record

Files

12 files changed.

- New "Start here — no tech skills needed" section before Developer Quick Start
  in every README language: Way 1 = hand the repo link to an AI agent (copy-paste
  prompt template in the reader's own language); Way 2 = download ZIP/release
  and let a local agent guide setup.
- Renamed Quick Start → Developer Quick Start.
- Fixed stale storage descriptions in 8 non-en/zh-CN READMEs (old pluggable
  SQLite/PG/Mongo wording → file-first model: personal SQLite / team CSV+git or SQL).
…erge

- zh-CN start-here: folder tip (axiara-workspace) as user guidance, not in the
  prompt; "方式一、把链接交给 AI Agents(最简单)/ 方式二、自己下载文件,再交给 AI Agents";
  prompts now in code blocks; added a manual update-check prompt.
- New auto-release workflow: every push to main bumps v0.x.y (patch) and creates
  a GitHub release (source zip/tar.gz auto-attached).
- Other language versions to be synced once zh-CN is approved.
@BerryUIKI BerryUIKI changed the title docs: start-here guide for non-technical users (all 10 languages) docs: start-here guide for non-technical users + auto-release Aug 4, 2026
@BerryUIKI

Copy link
Copy Markdown
Owner Author

The primary development language for this project is English; please update your PR details.

@BerryUIKI
BerryUIKI merged commit 313d279 into dev Aug 4, 2026
@BerryUIKI
BerryUIKI deleted the docs/start-here-guide branch August 6, 2026 09:06
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