Skip to content

Latest commit

 

History

History
58 lines (38 loc) · 1.55 KB

File metadata and controls

58 lines (38 loc) · 1.55 KB

AGENTS.md - Blogs Project

Purpose

This repository is a VuePress blog/notes site.

When writing or editing content here:

  • default to Chinese unless explicitly requested otherwise
  • write for general readers, not for a private coaching context
  • do not leak user profile, personal memory, or assistant-only context into published docs
  • prefer polished article structure over chat-style notes

Content Placement

  • Site pages live under docs/
  • General technical articles belong in docs/article/
  • AI/OpenClaw-related notes belong in docs/ai/
  • Frontend topic notes belong in docs/web/
  • Backend topic notes belong in docs/backend/
  • Ops topic notes belong in docs/ops/

Before creating a new page, choose the most natural existing section.

Writing Style

  • Prefer natural article prose over checklist-heavy outlines
  • Use clear section headings
  • Keep examples practical
  • Avoid over-personalized framing like "for you" or user-specific biography in published articles
  • Keep terminology accurate and consistent with Shopify / VuePress / engineering usage

Navigation

If a new article should be discoverable from the site, update:

  • docs/.vuepress/config.js

Especially check:

  • navbar entries
  • sidebar entries

Local Workflow

  • Dev: npm run docs:dev
  • Build: npm run docs:build
  • Deploy: ./deploy.sh

Git Safety

This repo may already contain unrelated user changes.

When committing:

  • stage only the files related to the requested work
  • do not sweep unrelated modifications into the same commit
  • keep commit messages focused and small