On Tue, Feb 9, 2021 at 12:51 PM Oscar Benjamin <[email protected]> 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 explanatory guides etc. We definitely need > high-level docs but at the moment there's nowhere to put them. > I'm inclined to agree with this. Either this or continued work on improving the style of docstrings. In general, I think GSoD and technical writer work in general is better spent improving the style and organization of existing documentation rather than writing new documentation. New documentation requires domain knowledge of SymPy itself, which most technical writers won't have. It's better for existing developers to write those. A technical writer could then improve that documentation, but the content itself for new documentation has to come from someone who has expert knowledge on the thing being documented. Aaron Meurer > > Oscar > > On Tue, 9 Feb 2021 at 19:32, Aaron Meurer <[email protected]> wrote: > > > > 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 technical writers applied to work > with organizations. This year, instead organizations submit a proposal to > Google and if accepted, Google gives them a grant to hire a technical > writer. > > > > What this means is that we need to pick a project ourselves and apply > for it. Technical writers will then apply to work on that one project. If > you are a technical writer or know of one who may be interested in > applying, see > https://developers.google.com/season-of-docs/docs/tech-writer-guide. > > > > Here is the list of ideas that we used last year > https://github.com/sympy/sympy/wiki/GSoD-2020-Ideas. Which idea do people > think is the most important one? If you are a technical writer who is > interested in working with us, we would like to hear your feedback too. > > > > The rules for organizations are at > https://developers.google.com/season-of-docs/docs/admin-guide. > > > > Aaron Meurer > > > > -- > > You received this message because you are subscribed to the Google > Groups "sympy" group. > > To unsubscribe from this group and stop receiving emails from it, send > an email to [email protected]. > > To view this discussion on the web visit > https://groups.google.com/d/msgid/sympy/CAKgW%3D6%2Bxx0htU2w5cYmoSxtpy82LthcmnskfGxNwUXA5YL5HSQ%40mail.gmail.com > . > > -- > You received this message because you are subscribed to the Google Groups > "sympy" group. > To unsubscribe from this group and stop receiving emails from it, send an > email to [email protected]. > To view this discussion on the web visit > https://groups.google.com/d/msgid/sympy/CAHVvXxSzR8vjsioO7XhsJx2CtZuqgiBzeAi%2BVE-wBAPm3P_RuA%40mail.gmail.com > . > -- You received this message because you are subscribed to the Google Groups "sympy" group. To unsubscribe from this group and stop receiving emails from it, send an email to [email protected]. To view this discussion on the web visit https://groups.google.com/d/msgid/sympy/CAKgW%3D6JRNnwxnWS3Fr8bKrvQijeFa3o_g%2B54SeqDjBtB31E_CA%40mail.gmail.com.
