docs: MkDocs site + ICA/AMICA concepts, figures, community files - #97
Merged
Conversation
5 tasks
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.
Closes #96.
Documentation for the JOSS-readiness track (Phase R2 in
.context/plan.md): the MkDocs Material site, an intro theory section with figures, and the community-health files.What changed
mkdocs.yml(Material theme,mkdocstringswithdocstring_style: numpy, git-revision-date),docsextra inpyproject.toml,.github/workflows/docs.yml(build + deploy to GitHub Pages),.gitignoreforsite/.docs/assets/figures/): ICA source->mix->unmix schematic, mixing-geometry scatter, generalized-Gaussian density family, mixture source density, AMICA algorithm-flow diagram, and a log-likelihood convergence curve from a real AMICA fit on the bundled sample EEG (final LL = -3.404, matching the Fortran-parity target).CONTRIBUTING.md,CODE_OF_CONDUCT.md(Contributor Covenant 2.1),CITATION.cff(with the Palmer/Kreutz-Delgado/Makeig 2012 AMICA reference).Verification
uv run mkdocs build --strictis green.Hosting
Once the repo is at
github.com/sccn/pyAMICA, its project Pages serve at the sccn org Pages custom domain subpath ->https://eeglab.org/pyAMICA/. Links are relative; stages atneuromechanist.github.io/pyAMICA/pre-transfer.Notes / follow-ups
Tested
uv run mkdocs build --strict(green). Docs/meta only; no runtime code touched.