Skip to content

refactor(docs): reorganize docs/ into agent/dev/user + trim agent_workflow - #17

Closed
Dimcirui wants to merge 5 commits into
mainfrom
docs/agent-workflow-split
Closed

Dimcirui wants to merge 5 commits into
mainfrom
docs/agent-workflow-split

Conversation

@Dimcirui

Copy link
Copy Markdown
Owner

Summary

Directory restructuring + content extraction to separate agent-facing docs from human-facing docs.

Changes

Directory Reorganization

Old New
docs/agent_workflow.md docs/agent/agent_workflow.md
docs/design.md, backlog.md, plugin_api.md, e2e_fixes.md, phase5_material.md, blender-mcp-analysis.md docs/dev/*
docs/demo_setup.md, plan.md docs/user/*

agent_workflow.md Simplified (1311 → 964 lines, -27%)

  • Extracted Common Errors + Background → new docs/dev/troubleshooting.md
  • Extracted Operator Index → new docs/dev/agent-api.md (full 29-tool reference with bpy.ops.* mappings)
  • All cross-references updated across 14 files
  • prompts.py path updated to docs/agent/agent_workflow.md

Merge Notes

  • backlog.md had conflict: keep main's version (trimmed by feb6a53) at docs/dev/backlog.md
  • CHANGELOG.md should stay at repo root
  • toolkit_probe.py / ToolkitStatusPanel / ResizeHandle from feb6a53 unaffecte

Dimcirui added 3 commits May 19, 2026 04:50
Move agent_workflow.md → docs/agent/
Move design/backlog/plugin/e2e docs → docs/dev/
Move demo/plan docs → docs/user/
Update all cross-references across 14 files.
…s/dev/troubleshooting.md

Move ~260 lines of debugging reference and background prose out of
the agent's system-prompt source. Each section now carries a one-line
reference pointing to troubleshooting.md for human readers.

- agent/agent_workflow.md: 1311 → 983 lines (-25%)
- dev/troubleshooting.md: new (260 lines)
…or Index

Create docs/dev/agent-api.md — complete listing of all 29 callable Agent
tools (17 phase + 10 query + 2 meta) with bpy.ops mappings and source
locations, organized by pipeline stage.

Replace the incomplete Toolkit Operator Index in agent_workflow.md
with a one-line reference. Remove 7 <!-- FILL IN --> placeholders.
agent_workflow.md: 983 → 964 lines
@Dimcirui

Copy link
Copy Markdown
Owner Author

@copilot resolve the merge conflicts in this pull request.
preserve the backlog content on main branch and move it to docs/dev/backlog.md

Copilot AI and others added 2 commits May 19, 2026 08:17

Copilot AI commented May 19, 2026

Copy link
Copy Markdown
Contributor

@copilot resolve the merge conflicts in this pull request.
preserve the backlog content on main branch and move it to docs/dev/backlog.md

Done in commit 39bad16. I resolved the conflict by restoring the backlog content from main and keeping it at docs/dev/backlog.md (with moved-path link fixes). No UI files were changed, so there is no UI screenshot for this update.

@Dimcirui

Copy link
Copy Markdown
Owner Author

@copilot resolve the merge conflicts in this pull request

@Dimcirui Dimcirui closed this May 19, 2026
Copilot stopped work on behalf of Dimcirui due to an error May 19, 2026 08:24
@Dimcirui Dimcirui reopened this May 19, 2026
@Dimcirui Dimcirui closed this May 19, 2026
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.

2 participants