search

LMBooth / pybci

Create real-time BCI's with the LSL, PyTorch, SKLearn and TensorFlow packages.
https://pybci.readthedocs.io/en/latest/
MIT License
22 stars 4 forks source link

DOC: Introduction section seems unintuitive #9

Closed jsheunis closed 1 year ago

jsheunis commented 1 year ago

The Introduction section of the docs seems a bit unintuitive. To me, "Introduction" is more about an overview of the tool, and not installation and usage. Currently it contains "Installation", "Simple Implementation", and "What is PyBCI?". I suggest reordering it at the top level to a "Get started" section, which contains all the information a user would need to get started. This would be Installation and Simple Implementation. Then I would move the "What is PyBCI?" into its own section, maybe "Introduction" or "Overview", or even "What is PyBCI"

Ping https://github.com/openjournals/joss-reviews/issues/5706

jsheunis commented 1 year ago

I would also add a place for prerequisites before the installation. Then the paragraph about LSL for non-windows systems can move there, and you can also mention the minimum python version.

LMBooth commented 1 year ago

Thankyou for these recommendations @jsheunis, i've had a reshuffle and will close the issue for now. Hopefully the information is now presented in a more intuitive manner.