Skip to content

[WIP] Create a handbook for our group - #62

Merged
gvegayon merged 5 commits into
mainfrom
copilot/fix-61
Sep 22, 2025
Merged

gvegayon merged 5 commits into
mainfrom
copilot/fix-61

Conversation

Copilot AI commented Sep 22, 2025 •

Copy link
Copy Markdown
Contributor

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

  • Set up minimal uv environment - Created pyproject.toml with only essential dependencies (mkdocs, mkdocs-material)
  • Configure mkdocs - Set up mkdocs.yml with Material theme and proper navigation structure
  • Create all required chapters with placeholder content:
    • Writing R packages (handbook/r-packages.md)
    • Writing Python Libraries (handbook/python-libraries.md)
    • ShinyApps (handbook/shiny-apps.md)
    • Code for papers (handbook/code-for-papers.md)
    • Agile planning (handbook/agile-planning.md)
  • GitHub Actions workflow (.github/workflows/handbook.yml) with all required features:
    • Uses astral-sh/setup-uv action for uv setup
    • Builds documentation as artifact using upload-artifact
    • Uses CDCgov/cfa-actions/post-artifact for PR comments (fixed configuration)
    • Uses upload-pages-artifact for GitHub Pages preparation
    • Uses deploy-pages action for main branch deployment
  • Proper build configuration - Updated .gitignore to exclude build artifacts

🎯 Key Features

  • Material Design: Modern, responsive documentation with search functionality
  • Organized Structure: Clear navigation with Home and Best Practices sections
  • Placeholder Content: All chapters include structured placeholders for future expansion
  • GitHub Integration: Direct links to repository and proper GitHub Pages setup
  • Automated Workflow: Builds on PR changes, deploys on main branch merges

📸 Screenshots

Homepage: Handbook Homepage

R Packages Chapter: R Packages Chapter

🚀 Next Steps

The handbook infrastructure is complete and ready for content development. Team members can now:

  1. Expand placeholder chapters with detailed best practices
  2. Add examples and code snippets to each section
  3. Customize the theme and add additional sections as needed
  4. The workflow will automatically build and deploy changes

📁 Files Added/Modified

  • pyproject.toml - uv configuration
  • mkdocs.yml - MkDocs configuration
  • handbook/ - Directory with all handbook content
  • .github/workflows/handbook.yml - Complete CI/CD workflow (fixed post-artifact configuration)
  • .gitignore - Updated to exclude build artifacts

The 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.

Co-authored-by: gvegayon <893619+gvegayon@users.noreply.github.com>
@gvegayon
gvegayon marked this pull request as ready for review September 22, 2025 16:33

@gvegayon gvegayon left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@copilot, please address the comment.

Comment thread .github/workflows/handbook.yml
Co-authored-by: gvegayon <893619+gvegayon@users.noreply.github.com>
@github-actions

github-actions Bot commented Sep 22, 2025 •

Copy link
Copy Markdown
Contributor

Thank you for your contribution @Copilot 🚀! Your handbook-site is ready for download 👉 here 👈!
(The artifact expires on 2025-12-21T16:58:10Z. You can re-generate it by re-running the workflow here.)

@gvegayon gvegayon left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@gvegayon
gvegayon merged commit 0385237 into main Sep 22, 2025
@gvegayon
gvegayon deleted the copilot/fix-61 branch September 22, 2025 17:15
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.

Create a handbook for our group

2 participants