Switching to a separate branch for generated HTML documentation, especially for GitHub Pages, offers several advantages:
Organized Repository: Separating source and built content provides clarity. One branch hosts raw, editable content while the other contains the generated static site.
Streamlined Commit History: Merging source and generated content clutters commit histories. By compartmentalizing the generated content, the main branch's commit history remains clean and centered on source modifications.
Efficient PR Reviews: A dedicated HTML branch ensures that pull requests only reflect source changes, not generated output, simplifying the review process.
Switching to a separate branch for generated HTML documentation, especially for GitHub Pages, offers several advantages:
Organized Repository: Separating source and built content provides clarity. One branch hosts raw, editable content while the other contains the generated static site.
Streamlined Commit History: Merging source and generated content clutters commit histories. By compartmentalizing the generated content, the main branch's commit history remains clean and centered on source modifications.
Efficient PR Reviews: A dedicated HTML branch ensures that pull requests only reflect source changes, not generated output, simplifying the review process.