Skip to content

Polish standalone docs and add notebook examples#5

Merged
mhmdaskari merged 1 commit into
mainfrom
standalone-docs-notebook-examples
May 23, 2026
Merged

Polish standalone docs and add notebook examples#5
mhmdaskari merged 1 commit into
mainfrom
standalone-docs-notebook-examples

Conversation

@mhmdaskari

Copy link
Copy Markdown
Owner

Summary

  • Reframes README and documentation around eegclassify as a standalone Python package.
  • Removes legacy/course/notebook-derived wording from public docs and generated API docstrings.
  • Keeps the course-origin report link and archived notebook pointer only at the end of the README.
  • Adds rendered notebook examples under docs/examples/ and wires them into MkDocs navigation with mkdocs-jupyter execution disabled.
  • Updates notebook narratives and reference-target labels to avoid legacy-baseline wording.

Validation

  • rg -n "legacy|built from|built on|original notebooks|notebooks/legacy|course split|legacy parity|original notebook|original project|C247|Report\\.pdf" README.md docs mkdocs.yml notebooks src -g '!notebooks/legacy/**'
    • Only the two allowed README ending lines remain.
  • CUDA_VISIBLE_DEVICES=-1 mkdocs build --strict
  • git diff --check
  • python3 -m compileall -q src
  • git check-attr linguist-detectable -- docs/examples/00_data_postprocessing.ipynb notebooks/00_data_postprocessing.ipynb

@mhmdaskari mhmdaskari self-assigned this May 23, 2026
@mhmdaskari mhmdaskari merged commit 4016470 into main May 23, 2026
2 checks passed
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