Skip to content

Comments

Add devcontainer and using git action to deploy docs#23

Open
Truongphi20 wants to merge 21 commits intosmcclatchy:gh-pagesfrom
Truongphi20:main
Open

Add devcontainer and using git action to deploy docs#23
Truongphi20 wants to merge 21 commits intosmcclatchy:gh-pagesfrom
Truongphi20:main

Conversation

@Truongphi20
Copy link

@Truongphi20 Truongphi20 commented Nov 22, 2025

Hi @smcclatchy,

I'm a genomic researcher and really excited about your free QTL mapping course! I’ve added a few enhancements to make the course structure more portable and easier to develop further.

Updates

  • Devcontainer setup
    Added a ready-to-use devcontainer with Docker. You can quickly start working in VSCode via Ctrl+Shift+P → Devcontainer: Reopen in Container.

  • Folder cleanup
    Ignored auto-generated files to keep the repo tidy:

    • Markdown figures in ./fig
    • Temporary markdown files in _episodes
  • GitHub Actions deployment

    • Workflow set up to deploy the docs, separating code from deployment. Codebase is maintained on branch main, and branch gh-page is used for deployment,
    • To deploy, go to GitHub GUI of repository: Actions → Deploy to GitHub Pages → Run workflow.

I already tested and deployed successfully. See :

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.

1 participant