Skip to content

docs: add comprehensive MkDocs documentation website#77

Merged
jayhesselberth merged 2 commits intomainfrom
docs
Jan 14, 2026
Merged

docs: add comprehensive MkDocs documentation website#77
jayhesselberth merged 2 commits intomainfrom
docs

Conversation

@jayhesselberth
Copy link
Member

Summary

  • Add complete MkDocs documentation site with Material theme
  • 21 documentation pages covering all aspects of the pipeline
  • GitHub Actions workflow for automatic deployment to GitHub Pages

Documentation Structure

Section Pages
Getting Started Installation, Quick Start, First Analysis
User Guide Configuration, Sample Files, Running Pipeline, Outputs
Workflow Overview, Rules Reference, Scripts Reference, Demultiplexing
Cluster Setup LSF, SLURM, GPU Configuration
Troubleshooting Common Errors, FAQ, Debugging
Development Architecture, Adding Rules, Contributing

Features

  • Mermaid diagrams for workflow visualization
  • Comprehensive rule-by-rule documentation (all 21 rules)
  • Python scripts reference (8 scripts)
  • WarpDemuX demultiplexing guide
  • Dark/light mode toggle
  • Search functionality
  • Code copy buttons

Setup Required After Merge

  1. Enable GitHub Pages in repository settings
  2. Set source to "GitHub Actions"
  3. Documentation will be available at https://rnabioco.github.io/aa-tRNA-seq-pipeline

Test plan

  • Preview locally with mkdocs serve
  • Verify all internal links work
  • Check mermaid diagrams render
  • Test search functionality
  • Verify GitHub Actions workflow passes

🤖 Generated with Claude Code

jayhesselberth and others added 2 commits January 14, 2026 07:16
Add a complete documentation site using MkDocs with Material theme:

- Getting Started: installation, quickstart, first analysis guides
- User Guide: configuration, sample formats, running pipeline, outputs
- Workflow: overview with mermaid diagrams, rules reference (all 21 rules),
  scripts reference (8 Python scripts), WarpDemuX demultiplexing guide
- Cluster Setup: LSF, SLURM, and GPU configuration guides
- Troubleshooting: common errors, FAQ, debugging techniques
- Development: architecture, adding rules, contributing guidelines

Infrastructure:
- mkdocs.yml with Material theme, mermaid support, code highlighting
- GitHub Actions workflow for auto-deployment to GitHub Pages
- Updated README with documentation badge and links

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Remove invalid anchor_linenumbers option that causes build failure.

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
@jayhesselberth jayhesselberth merged commit ac50971 into main Jan 14, 2026
9 of 12 checks passed
@jayhesselberth jayhesselberth deleted the docs branch January 14, 2026 14:43
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