Using DocFx for multiple repositories in one e.g. GitHub organization #7852
Unanswered
JeremyCaney
asked this question in
Q&A
Replies: 0 comments
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
-
How are folks handling situations where you have multiple repositories in one e.g. GitHub organization that are closely related? Are you setting up a separate DocFx project per repository? Or setting up a separate repository just for DocFx which (somehow) pulls in API metadata from source code or assemblies in the other repositories? Related, are you publishing the generated HTML via GitHub Pages via the per-repository branch, a separate organizational repository, or a separate service entirely?
My inclination is to setup a separate repository for DocFx and pull in the API metadata via the NuGet packages associated with each of the other repositories, and then managing conceptual documentation locally in the DocFx repository. This would then be published to GitHub pages for the organization.
Have you learned any lessons? Have any regrets with the approach you've taken? Any considerations that should be factored into this decision?
Related Discussion: Organization use of DocFx in a parent-children doc site and multiple separate projects #7408
Beta Was this translation helpful? Give feedback.
All reactions