https://github.com/douglasneuroinformatics/douglas_user_documentation

A wiki with documentation for common use cases and how to interact with the Douglas Neuroinformatics Platform
https://github.com/douglasneuroinformatics/douglas_user_documentation

Last synced: 8 months ago
JSON representation

A wiki with documentation for common use cases and how to interact with the Douglas Neuroinformatics Platform

Host: GitHub
URL: https://github.com/douglasneuroinformatics/douglas_user_documentation
Owner: DouglasNeuroInformatics
Created: 2021-05-12T20:08:51.000Z (about 5 years ago)
Default Branch: master
Last Pushed: 2025-02-20T20:57:06.000Z (over 1 year ago)
Last Synced: 2025-02-20T21:34:08.697Z (over 1 year ago)
Homepage: https://docs.douglasneuroinformatics.ca/
Size: 114 KB
Stars: 6
Watchers: 3
Forks: 3
Open Issues: 25
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

# Douglas Neuroinformatics Platform Documentation

[![All Contributors](https://img.shields.io/badge/all_contributors-7-orange.svg?style=flat-square)](#contributors-)

## To build locally

Follow these steps.

1. `cd docs`
2. `pip install -r requirements.txt`
3. `make html`
4. open `docs/_build/index.html`

To make changes, edit the markdown files.
If you have done a major refactor (renaming files or directory structures),
you can use `make clean html` to create a fresh build directory for local testing.

Also check out

- [MyST docs](https://myst-parser.readthedocs.io/en/latest/)
- [SPHINX docs](https://www.sphinx-doc.org/en/master/usage/quickstart.html)

## Contributing

If you want to contribute your expertise to this documentation,
the best place to start would be to
[create a new issue](https://github.com/DouglasNeuroInformatics/Douglas_User_Documentation/issues)
and describe the content you plan on adding.
This will allow other contributors to discuss with you
and is a good way to check if someone else is already working on a similar idea that you can collaborate on.

## Contributors ✨

Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):

_{isabelbacellar}
🤔 👀

_{Gabriel A. Devenyi}
🤔 🖋 📖 📆 ⚠️ 👀

_{Sebastian Urchs}
🤔 🖋 📖 📆

_{Jeremie Fouquet}
🖋 📖

_LuceroGG
📓 🤔

_Swapna
📓 🐛 🤔

_raihaan
🤔