search

datactive / bigbang

Scientific analysis of collaborative communities
http://datactive.github.io/bigbang/
MIT License
149 stars 52 forks source link

RTD structure ? #499

Closed sbenthall closed 2 years ago

sbenthall commented 2 years ago

RTD docs structure idea from @Christovis

https://bigbang-py.readthedocs.io/en/latest/

**Getting Started**
- Installation
- Motivation  (place this above Installation)
- License

**Documentation**
- Data sources
- Git as data source  (make this part of 'Data sources')
- API Documentation

(Should we give another bullet point to the preprocessing scripts for analysis and visualisation?)

**Community**
- Contribution (add this, to info on communication channels, code formatting, etc.)
- Data Access
- Release notes
sbenthall commented 2 years ago

Yes, let's have another bullet point for analysis and visualization preprocessing.

See #322 for data access.

Making these structural changes is easy. Filling them out is harder...