Skip to content

Use combined documentation to build all targets into a single site#69

Merged
albertodebortoli merged 1 commit intomainfrom
fix/docc-merge-outputs
Apr 12, 2026
Merged

Use combined documentation to build all targets into a single site#69
albertodebortoli merged 1 commit intomainfrom
fix/docc-merge-outputs

Conversation

@albertodebortoli
Copy link
Copy Markdown
Member

Summary

  • Replaces the manual two-step build + cp -r merge from Fix DocC build: generate targets separately and merge outputs #68 with a single --enable-experimental-combined-documentation invocation
  • This flag (swift-docc-plugin 1.4+) builds all package targets, passes --dependency flags between them so cross-target links resolve, and merges everything into one combined archive
  • Fixes the "page not found" issue on documentation/lucacore/ — the manual merge was copying HTML but missing the backing JSON data files that DocC's client-side router needs to render content

What changed

The DocC CI step is now a single command:

swift package generate-documentation \
  --enable-experimental-combined-documentation \
  --disable-indexing \
  --output-path ./docs \
  --transform-for-static-hosting \
  --hosting-base-path Luca

Test plan

  • Verify CI DocC workflow passes
  • Confirm https://luca.tools/Luca/documentation/lucacli/ loads with tutorials
  • Confirm https://luca.tools/Luca/documentation/lucacore/ loads with API reference
  • Verify cross-target links work (e.g. LucaCLI referencing LucaCore types)

@albertodebortoli albertodebortoli added this to the 0.15.0 milestone Apr 12, 2026
@albertodebortoli albertodebortoli added the documentation Improvements or additions to documentation label Apr 12, 2026
@albertodebortoli
Copy link
Copy Markdown
Member Author

Finally. This worked!

image

@albertodebortoli albertodebortoli merged commit 6d5c5a6 into main Apr 12, 2026
4 of 5 checks passed
@albertodebortoli albertodebortoli deleted the fix/docc-merge-outputs branch April 12, 2026 16:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant