Add documentation suite, license, and preprint citation#1
Merged
Conversation
…e docs Co-authored-by: Erfan7bt <72319134+Erfan7bt@users.noreply.github.com>
Co-authored-by: Erfan7bt <72319134+Erfan7bt@users.noreply.github.com>
Co-authored-by: Erfan7bt <72319134+Erfan7bt@users.noreply.github.com>
Co-authored-by: Erfan7bt <72319134+Erfan7bt@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Add full documentation and license file with references
Add documentation suite, license, and preprint citation
Feb 16, 2026
Erfan7bt
reviewed
Feb 16, 2026
Member
Erfan7bt
left a comment
There was a problem hiding this comment.
Documentation added by copilot. Reviewed and confirmed.
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.
Adds comprehensive documentation infrastructure for the AD_PAC MEG analysis pipeline and establishes proper attribution for the associated preprint (https://www.medrxiv.org/content/10.64898/2026.02.06.26345635v1).
Documentation Structure
Root-level (7 files, ~1.5K lines):
README.md- Project overview, installation, complete pipeline usageCITATION.md- Preprint citation with BibTeX for paper and dependenciesLICENSE- MIT LicenseREQUIREMENTS.md- Dependency installation (MATLAB, FieldTrip, Brainstorm, FreeSurfer)QUICKSTART.md- Rapid onboarding guide with timeline estimatesCONTRIBUTING.md- Contribution workflow and code of conductCHANGELOG.md- Version historyModule-level (5 files):
Each pipeline stage (
HeadModelling/,PreProcessing/,SourceReconstruction/,Pac/,Stat/) now includes detailed README covering:Key Features
.gitignoreconfigured to exclude large data files and resultsExample Usage Flow
Documentation provides complete coverage from installation through publication-ready analysis.
Warning
Firewall rules blocked me from connecting to one or more addresses (expand for details)
I tried to connect to the following addresses, but was blocked by firewall rules:
www.medrxiv.org/home/REDACTED/work/_temp/ghcca-node/node/bin/node /home/REDACTED/work/_temp/ghcca-node/node/bin/node --enable-source-maps /home/REDACTED/work/_temp/copilot-developer-action-main/dist/index.js(dns block)If you need me to access, download, or install something from one of these locations, you can either:
💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.