Skip to content

refactor: move DocFxForUnity.csproj into Documentation/#35

Merged
NormandErwan merged 1 commit intomainfrom
claude/move-docfx-project-B4506
May 3, 2026
Merged

refactor: move DocFxForUnity.csproj into Documentation/#35
NormandErwan merged 1 commit intomainfrom
claude/move-docfx-project-B4506

Conversation

@NormandErwan
Copy link
Copy Markdown
Owner

@NormandErwan NormandErwan commented May 3, 2026

$(cat <<'EOF'

Summary

  • Moves DocFxForUnity.csproj from the project root into Documentation/, so users only need to copy one folder to set up documentation instead of a folder plus a separate root-level file.
  • Adds an explicit <Compile Include="../Assets/**/*.cs" /> (with EnableDefaultCompileItems=false) since the SDK default glob no longer covers Assets/ from the new location.
  • Fixes the lib/UnityEngine CI fallback path to $(MSBuildProjectDirectory)/../lib/UnityEngine.
  • Updates Documentation/docfx.json metadata src from ".." to ".".
  • Updates README.md to reflect the simpler one-folder setup and the new .csproj location.

Test plan

  • Run docfx Documentation/docfx.json locally and verify metadata is generated for Assets/Scripts/Player.cs
  • Verify the CI workflow (documentation.yml) still builds successfully
  • Check that the lib/UnityEngine fallback path resolves correctly in CI
  • Confirm renamed .csproj scenario still works (rename inside Documentation/ and update docfx.json)

https://claude.ai/code/session_017hjwp9DHW2Sh6ZNhMF2Lbs
EOF
)


Generated by Claude Code

Simplifies setup: users only need to copy one folder (Documentation/)
instead of a folder plus a separate file at the project root.

- Add explicit Compile glob (../Assets/**/*.cs) since the SDK default
  no longer covers Assets/ from the new location
- Fix lib/UnityEngine fallback path to ../lib/UnityEngine
- Update docfx.json metadata src from ".." to "."
- Update README accordingly

https://claude.ai/code/session_017hjwp9DHW2Sh6ZNhMF2Lbs
@NormandErwan NormandErwan marked this pull request as ready for review May 3, 2026 19:24
@NormandErwan NormandErwan merged commit 388942e into main May 3, 2026
2 checks passed
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