docs: Add comprehensive tutorial documentation - #98
Merged
Conversation
- Create MkDocs site with Material theme - Add getting-started guide with installation options - Add interface-overview explaining all 5 tabs - Add ICA tab guide with detailed visualization explanations - Add classification-workflow guide with best practices - Add QC tab guide for quality control interpretation - Add troubleshooting guide for common issues - Set up GitHub Actions workflow for auto-deployment to GitHub Pages - Add Documentation button to About popup (links to https://me-ica.github.io/rica/) - Update README with docs badge and links Closes ME-ICA#23 Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
✅ Deploy Preview for rica-fmri ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
- Build docs on all PRs that modify docs/ or mkdocs.yml - Upload built docs as downloadable artifact - Deploy PR previews to gh-pages/pr-preview/pr-<number>/ - Auto-comment on PR with preview URL - Auto-cleanup preview when PR is closed Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds comprehensive tutorial documentation for Rica, addressing issue #23. It creates a MkDocs documentation site with Material theme that auto-deploys to GitHub Pages, along with integrating documentation access into the application itself.
Changes:
- Created 7 comprehensive documentation pages covering installation, interface, workflows, QC, and troubleshooting
- Added MkDocs configuration with Material theme and GitHub Pages deployment workflow
- Integrated documentation link into the About popup with primary button styling
- Added documentation badge and links to README
Reviewed changes
Copilot reviewed 11 out of 11 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
docs/index.md |
Home page with overview, features, video embed, and citation |
docs/getting-started.md |
Four installation options and comprehensive file requirements |
docs/interface-overview.md |
Detailed explanation of all five tabs and UI features |
docs/ica-tab-guide.md |
In-depth guide to ICA component visualization and classification |
docs/classification-workflow.md |
Best practices and workflow for manual component review |
docs/qc-tab-guide.md |
QC metrics interpretation and data quality assessment |
docs/troubleshooting.md |
Common issues, solutions, and bug reporting guidance |
mkdocs.yml |
MkDocs configuration with Material theme and navigation structure |
.github/workflows/docs.yml |
GitHub Actions workflow for automatic docs deployment |
src/PopUps/AboutPopUp.js |
Added Documentation button with primary styling |
README.md |
Added documentation badge and links |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
- Use official GitHub Pages deployment (actions/deploy-pages) - For PRs: upload artifact + comment with download instructions - Removes gh-pages push that fails on fork PRs due to permissions Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
- Remove PR comment (forks can't comment on upstream) - Keep artifact upload for PR preview (download from Actions tab) - Deploy to GitHub Pages only on master push Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
- Install Playwright and capture full-page screenshots of each doc page - Upload screenshots as artifact for easy visual review - Screenshots generated only on PRs, not on master push Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
- Add screenshots for all tabs: Info, ICA, Carpets, QC, Tree - Add About popup screenshot showing Documentation link - Update index.md with ICA tab preview - Update interface-overview.md with screenshots for each tab section Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
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.
Summary
Changes
7 documentation files in
docs/:index.md- Home page with overview and video embedgetting-started.md- Installation options and required filesinterface-overview.md- Explains all 5 tabsica-tab-guide.md- Detailed ICA visualization guideclassification-workflow.md- Best practices for component reviewqc-tab-guide.md- Quality control interpretationtroubleshooting.md- Common issues and solutionsConfiguration:
mkdocs.yml- MkDocs with Material theme.github/workflows/docs.yml- Auto-deploy to GitHub PagesApp integration:
Documentation URL
Once merged: https://me-ica.github.io/rica/
Test plan
pip install mkdocs-material && mkdocs serve)Closes #23
🤖 Generated with Claude Code