chore(docs): reorganize docs/ into guides/ spec/ prompts/ subdirs - #17
Merged
Conversation
Flat docs/ was accumulating mixed-purpose files (user guides + normative
specs + AI session prompts + reference materials). Introduce three
semantic subdirs to scale past Phase 2A.5:
docs/guides/ user-facing how-tos (install, future: author-workflows)
docs/spec/ normative specs (math, schema)
docs/prompts/ Phase-level AI master prompts (living docs)
Renames (git -M detected):
docs/install.md -> docs/guides/install.md
docs/math_derivation.md -> docs/spec/math_derivation.md
docs/schema_v1.md -> docs/spec/schema_v1.md
New:
docs/prompts/phase2a5_master_prompt.md
Living doc — header "current progress" block gets updated after
each 17X merge; body task/constraints stay stable. Supersedes
the ephemeral per-session master prompt that used to live in
~/.claude/plans/.
Path references updated in-place (zero behavior change):
README.md 3 hrefs
kernel/include/rbfmax/*.hpp 5 comment refs across
{distance, interpolator, io_json,
kernel_functions, quaternion}
kernel/src/io_json.cpp 1 comment ref
Historical references in DEVLOG.md and CHANGELOG.md intentionally
left at old paths — they are audit-trail records of what the repo
looked like at the time of each slice.
Local verification: cmake build Release clean; ctest --test-dir build
159/159 PASS (zero regression). No functional source code edited.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
The docs/源文档/ tree holds research inputs that the project depends on as reference (铁拳 8 PPT + PDF, chadvernon cmt/jsRadial source drops, internal prompt-engineering draft) but intentionally never ships: licensing on the Tekken materials is unclear, the upstream MIT source is fetched as a one-time snapshot, and the prompt docx is an internal drafting artifact. Before this commit every git status / gh pr create surfaced three persistent ?? entries — easy to tune out, but noise compounds as more Phase 2A.5 slices land. Ignoring the whole subtree makes the working tree quiet without losing local copies. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Docs 目录从扁平结构整理为三个语义子目录，支撑 Phase 2A.5 + 未来阶段的文档规模：
零行为变更。7 处源码注释 + README 的路径引用就地更新，CI 应按常规绿。
Changes
Renames（git -M 检测到 100% rename，历史保留）:
New:
Path reference updates（注释改动，零行为）:
Historical references untouched:
Test plan
Scope discipline
🤖 Generated with Claude Code