Skip to content

Commit 5af58c9

Browse files
ypriverolclaude
andcommitted
docs: rewrite quantms documentation for DDA-only pipeline
- Completely rewrote usage.md: removed all nf-core RNA-seq boilerplate (STAR, fastq columns, genome parameter), replaced with DDA-focused content covering SDRF/CSV input, Comet/MS-GF+/Sage search engines, MS2PIP+DeepLC+Percolator rescoring, LFQ and TMT/iTRAQ quantification, PTM localization, cloud execution, and common parameter combinations - Rewrote output.md: removed DIA workflow sections, focused on DDA-LFQ and DDA-ISO outputs (mzTab, MSstats CSV, parquet PSM tables, pmultiqc); added note pointing DIA users to quantmsdiann docs - Added input.md: new page covering SDRF format (with required/optional columns and example), CSV samplesheet, spectra file formats (.raw/.mzML/.d), FASTA database recommendations, and TMT correction matrices - Added publications.md: citations for quantms and all integrated tools (Comet, MS-GF+, Sage, MS2PIP, DeepLC, Percolator, MS2Rescore, OpenMS, MSstats, pmultiqc, SDRF) plus community/support links - Updated index.md: added quantms_metro.png workflow diagram and updated pipeline overview to include Sage - Updated mkdocs.yml: expanded nav from 5 to 7 pages (added Input Files and Publications), added toc_depth: 2 Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
0 parents  commit 5af58c9

25 files changed

+4120
-0
lines changed

.github/workflows/deploy-docs.yml

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
name: Deploy Documentation
2+
3+
on:
4+
push:
5+
branches: [gh-pages-source]
6+
workflow_dispatch:
7+
8+
permissions:
9+
contents: read
10+
pages: write
11+
id-token: write
12+
13+
concurrency:
14+
group: "pages"
15+
cancel-in-progress: false
16+
17+
jobs:
18+
build:
19+
runs-on: ubuntu-latest
20+
steps:
21+
- name: Checkout
22+
uses: actions/checkout@v4
23+
24+
- name: Setup Python
25+
uses: actions/setup-python@v5
26+
with:
27+
python-version: '3.11'
28+
29+
- name: Install MkDocs
30+
run: pip install mkdocs-material
31+
32+
- name: Build docs
33+
run: mkdocs build --site-dir site
34+
35+
- name: Setup Pages
36+
uses: actions/configure-pages@v5
37+
38+
- name: Upload artifact
39+
uses: actions/upload-pages-artifact@v3
40+
with:
41+
path: site
42+
43+
deploy:
44+
environment:
45+
name: github-pages
46+
url: ${{ steps.deployment.outputs.page_url }}
47+
runs-on: ubuntu-latest
48+
needs: build
49+
steps:
50+
- name: Deploy to GitHub Pages
51+
id: deployment
52+
uses: actions/deploy-pages@v4

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
.idea

README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# quantms documentation
2+
3+
This branch contains the MkDocs Material documentation source for quantms.
4+
5+
The documentation is built and deployed to https://docs.quantms.org/ via GitHub Actions.
6+
7+
For the pipeline source code, see the `main` or `dev` branches.

mkdocs.yml

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
site_name: quantms
2+
docs_dir: mkdocs
3+
site_description: Cloud-ready Nextflow pipeline for DDA quantitative proteomics
4+
site_author: BigBio Team
5+
site_url: https://docs.quantms.org/
6+
repo_name: bigbio/quantms
7+
repo_url: https://github.com/bigbio/quantms
8+
theme:
9+
name: material
10+
custom_dir: mkdocs/overrides
11+
font: false
12+
palette:
13+
- scheme: default
14+
primary: blue
15+
accent: indigo
16+
toggle:
17+
icon: material/brightness-7
18+
name: Switch to dark mode
19+
- scheme: slate
20+
primary: blue
21+
accent: indigo
22+
toggle:
23+
icon: material/brightness-4
24+
name: Switch to light mode
25+
features:
26+
- navigation.sections
27+
- navigation.top
28+
- navigation.footer
29+
- content.code.copy
30+
extra_css:
31+
- https://quantms.org/css/quantms-theme.css
32+
nav:
33+
- Home: index.md
34+
- Installation: installation.md
35+
- Input Files: input.md
36+
- Workflows: workflows.md
37+
- Usage: usage.md
38+
- Output: output.md
39+
- Publications: publications.md
40+
41+
plugins:
42+
- search
43+
44+
markdown_extensions:
45+
- pymdownx.highlight:
46+
anchor_linenums: true
47+
- pymdownx.inlinehilite
48+
- pymdownx.superfences
49+
- pymdownx.tabbed:
50+
alternate_style: true
51+
- admonition
52+
- pymdownx.details
53+
- attr_list
54+
- tables
55+
- toc:
56+
permalink: true
57+
toc_depth: 2

mkdocs/images/full-DDA.svg

Lines changed: 228 additions & 0 deletions
Loading

mkdocs/images/id-dda-pipeline.png

298 KB
Loading

mkdocs/images/id_pipeline.png

298 KB
Loading

mkdocs/images/id_pipeline.svg

Lines changed: 228 additions & 0 deletions
Loading

mkdocs/images/ms-proteomics.png

216 KB
Loading

mkdocs/images/msms.png

32.2 KB
Loading

0 commit comments

Comments
 (0)