[Bigbang-dev] Automated documentation for BigBang -> Readthedocs

[Niels ten Oever]

Hi Seb,

Why is readthedoc better than a webpage? Or would readtthedocs replace the webpage and/or the Readme? I think it would be a bad idea to have one more place to maintain, because it might introduce inclarities or even inconsistencies. 

Am also happy to work on this, but I would strongly suggest that there is only one place with instructions.

Let's also talk about whether we toss out conda and keep pip, because keeping two installation modes is more confusing than that is actually helps imho. 

Best,

Niels

On 26-02-2021 16:25, Sebastian Benthall wrote:
> BigBang has made it this far without automated or standardized documentation.
> 
> But based on the wider interest in the project and the calls to ease onboarding, I'd like to make this a focus for the sprint.
> 
> I'll take responsibility for getting some documentation for BigBang up on readthedocs
> 
> https://readthedocs.org/ <https://readthedocs.org/>
> https://github.com/datactive/bigbang/issues/412 <https://github.com/datactive/bigbang/issues/412>
> 
> A readthedocs page has many benefits.
>  - A de facto landing page, explaining the purpose of the project, that is more accessible than the GitHub repository
>  - A navigable place to look for documentation and examples (and videos)
>  - A way to publish API documentations and enforce style in docstrings
> 
> I've been doing a lot of work on RTD docs for a different project [1] and so am prepared to take this on.
> 
>  Best regards,
> Seb
> 
> [1] https://hark.readthedocs.io/en/latest/ <https://hark.readthedocs.io/en/latest/>
>  
> 
> _______________________________________________
> Bigbang-dev mailing list
> Bigbang-dev at data-activism.net
> https://lists.ghserv.net/mailman/listinfo/bigbang-dev
> 

-- 
Niels ten Oever, PhD
Postdoctoral Researcher - Media Studies Department - University of Amsterdam
Research Fellow - Centre for Internet and Human Rights - European University Viadrina
Associated Scholar - Centro de Tecnologia e Sociedade - Fundação Getúlio Vargas

https://nielstenoever.net - mail at nielstenoever.net - @nielstenoever - +31629051853
PGP: 2458 0B70 5C4A FD8A 9488 643A 0ED8 3F3A 468A C8B3

Read my latest article on Internet infrastructure governance in New Media & Society here: https://journals.sagepub.com/doi/full/10.1177/1461444820929320