Skip to content

docs: align project guides with both skills and current release - #17

Merged
sansi-lcj merged 1 commit into
mainfrom
codex/docs-consistency
Sep 15, 2026
Merged

sansi-lcj merged 1 commit into
mainfrom
codex/docs-consistency

Conversation

@sansi-lcj

Copy link
Copy Markdown
Member

Summary / 摘要

Project guides still described an Argus-only installation, chat-based credential collection, and the initial 2.0 promotion as current instructions. Align the bilingual documentation and machine index with both supported skills, the current stable metadata, and the actual installation and release scripts.

  • Explain Argus remote processing versus local Blender reconstruction, host-specific installation, and the Argus-only scope of the dedicated Codex installer and Arkclaw package. Clarify that the v2.0.0 tag does not contain Blender.
  • Centralize credential setup and upload consent in the usage guide. Simplify Argus command examples to use a shell whose credentials are already resolved.
  • Update architecture, development, contribution, support, security, release, and issue-template wording. Separate historical promotion steps from current gate requirements and document the limits of doctor:live.
  • Rebuild the Claude and Arkclaw copies. Runtime behavior, installer behavior, release gates, and version metadata are unchanged.

同步两项 skill 的安装与使用说明,统一凭据及授权规则,修正维护、发布与支持文档中的过时内容;中英文和生成分发副本保持一致。

Validation / 校验

  • npm run validate:docs
  • npm run validate:ai
  • npm run rebuild
  • npm run ci
  • Other: validate:skills, git diff --check, issue-template YAML parsing, and 399 local links/heading anchors across 98 tracked Markdown files.

Full CI passed in a clean temporary copy: 15 repository tests and 116 skill tests. The final tracked files were checked byte-for-byte against that tested copy.

The original workspace CI remains blocked by a pre-existing temporary PDF script containing a prohibited local absolute path. That file and the pre-existing untracked interface document are excluded from this PR.

Additional npm run smoke did not pass: the fresh-plugin dependency installation in a temporary directory failed with npm EALLOWSCRIPTS (--allow-scripts is not allowed in project-scoped installs). No host configuration was changed. No Argus upload, Blender reconstruction, or release was performed.

完整 CI 在干净临时副本中通过,共 131 项测试;最终文件与该副本一致。原工作区检查受已有临时文件影响,额外安装烟测受 npm 配置冲突阻断,均未计为通过。

Checklist / 检查项

  • The change is scoped to one problem.
  • Documentation reflects changed commands, configuration, release gates, or skill usage.
  • Source skill changes were rebuilt into plugins/realsee-skills/ and, for Argus, arkclaw/argus/ when needed.
  • No secrets, generated credentials, account identifiers, private URLs, GLB files, or temporary workspaces are committed.
  • This change is a maintainer-controlled update, not an unsolicited roadmap or product feature proposal.

@sansi-lcj
sansi-lcj merged commit cde0d4a into main Sep 15, 2026
4 checks passed
@sansi-lcj
sansi-lcj deleted the codex/docs-consistency branch September 15, 2026 06:17
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