[sympy] Google Season of Docs 2021

2021-02-09 Thread Aaron Meurer
Google has announced Google Season of Docs (GSoD) again for 2021. GSoD is a program that pairs technical writers with open source projects. We have participated in the past two years. The GSoD program has changed quite a bit this year. In the past, it was run like Google Summer of Code, where tech

Re: [sympy] Google Season of Docs 2021

2021-02-09 Thread Oscar Benjamin
Hi Aaron, I would go with "Organization of Documentation" as the most important. We need to get it organised so that there is a clear distinction between user functions vs internals and so that there are good cross-references to explanatory guides etc. We definitely need high-level docs but at the

Re: [sympy] Google Season of Docs 2021

2021-02-09 Thread Aaron Meurer
On Tue, Feb 9, 2021 at 12:51 PM Oscar Benjamin wrote: > Hi Aaron, > > I would go with "Organization of Documentation" as the most important. > We need to get it organised so that there is a clear distinction > between user functions vs internals and so that there are good > cross-references to ex

Re: [sympy] Google Season of Docs 2021

2021-02-10 Thread C.S.R. Tejasvi
Hi Aaron and Oscar, I am Tejasvi Chebrolu, a computer science sophomore at International Institute of Information Technology, Hyderabad. I have recently been trying to improve my technical writing skills and would like to work with SymPy as a part of GSoD-2021. After going through the ideas on htt

Re: [sympy] Google Season of Docs 2021

2021-02-10 Thread Soumi7
Hi Tejasvi, This issue (https://github.com/sympy/sympy/issues/19591) has links to all modules that have been updated. You can start by updating other modules to follow the documentation style guide mentioned here : https://docs.sympy.org/latest/documentation-style-guide.html. Thanks, Soumi.