Repository navigation
[WIP] Create a handbook for our group - #62
Merged
Merged
Conversation
Co-authored-by: gvegayon <893619+gvegayon@users.noreply.github.com>
Copilot stopped work on behalf of
gvegayon due to an error
September 22, 2025 16:29
gvegayon
marked this pull request as ready for review
September 22, 2025 16:33
Co-authored-by: gvegayon <893619+gvegayon@users.noreply.github.com>
Copilot stopped work on behalf of
gvegayon due to an error
September 22, 2025 16:40
Contributor
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
ForeSITE Group Handbook Implementation Complete ✅
I have successfully implemented a complete handbook system for the ForeSITE group using MkDocs and GitHub Actions as requested in issue #61.
✅ Completed Implementation
pyproject.tomlwith only essential dependencies (mkdocs, mkdocs-material)mkdocs.ymlwith Material theme and proper navigation structurehandbook/r-packages.md)handbook/python-libraries.md)handbook/shiny-apps.md)handbook/code-for-papers.md)handbook/agile-planning.md).github/workflows/handbook.yml) with all required features:astral-sh/setup-uvaction for uv setupupload-artifactCDCgov/cfa-actions/post-artifactfor PR comments (fixed configuration)upload-pages-artifactfor GitHub Pages preparationdeploy-pagesaction for main branch deployment.gitignoreto exclude build artifacts🎯 Key Features
📸 Screenshots
Homepage:
R Packages Chapter:
🚀 Next Steps
The handbook infrastructure is complete and ready for content development. Team members can now:
📁 Files Added/Modified
pyproject.toml- uv configurationmkdocs.yml- MkDocs configurationhandbook/- Directory with all handbook content.github/workflows/handbook.yml- Complete CI/CD workflow (fixed post-artifact configuration).gitignore- Updated to exclude build artifactsThe handbook is fully functional and will be available at
https://epiforesite.github.io/software/once deployed to GitHub Pages.Fixes #61.
✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.