1. Repository Guidelines

1.1. Project Structure & Module Organization

This is the Chinese GitBook manual for the 拍马 product family. Numbered top-level directories define navigation: 1_即影即有2025-拍马Print-自动打印/ is the current Print guide, 2_拍马连-图传App/ covers the transfer app, and directories marked 过时淘汰 retain legacy instructions. Keep screenshots beside their guides in descriptive subdirectories. Shared assets belong under assets/; GitBook settings are in book.json. CI generates SUMMARY.md; do not edit it manually.

Use the owning repository when documentation work requires checking current behavior:

  • Server API: /Volumes/ssd_data/code_library/paima/paima_software
  • Admin UI: /Volumes/ssd_data/code_library/paima/paima_software_ui
  • Live-photo UI: /Volumes/ssd_data/code_library/paima/paima_photo_live
  • Desktop app: /Volumes/ssd_data/code_library/paima/pmp_qt
  • Android app: /Volumes/ssd_data/code_library/paima/android/paimalink
  • iOS app: /Volumes/ssd_data/code_library/paima/ios/paimalink_ios

Verify product names, UI labels, workflows, and screenshots against the relevant implementation before documenting them. Do not edit another repository unless the task explicitly includes it.

1.3. Build, Test, and Development Commands

  • gitbook install installs the plugins declared in book.json.
  • book sm -d -s '_' -i node_modules regenerates SUMMARY.md using underscore-prefixed ordering while ignoring dependencies.
  • gitbook serve builds the manual and starts a local preview server.
  • gitbook build . _book performs the production-style static build locally.
  • bash scripts/build_gitbook_base_image.sh rebuilds the legacy CI image; use it only for toolchain changes.

The GitLab pipeline regenerates navigation, builds into public/, and deploys only from master.

1.4. Writing Style & Naming Conventions

Write concise Simplified Chinese for end users. Use one # title per page, descriptive ## sections, numbered procedures, and fenced code blocks for commands. Follow numeric filenames such as 3_模板设置.md. Use meaningful Chinese image names and relative links; update every reference after moves. Do not commit _book/, public/, node_modules/, or .DS_Store.

1.5. Testing Guidelines

There is no unit-test suite. Regenerate the summary and run gitbook build . _book. Review navigation, images, internal links, heading hierarchy, and screenshot readability. Check the changed page and adjacent pages.

1.6. Commit & Pull Request Guidelines

History uses short Chinese Conventional Commit-style subjects: feat: 新增…, fix: 修正…, or refactor: 重命名…. Keep commits focused and include related assets. Pull requests should summarize affected guides, explain moves, link issues when available, and include before/after screenshots for visual changes. Confirm the GitBook build passes.

Copyright © 2014-2026 拍马软件 all right reserved,powered by Gitbook该文件修订时间: 2026-07-19 17:39:48

results matching ""

    No results matching ""