Hello, Mukulika! Your project seems very ambitious! My advice would be to focus on one of two of those items and really spend some time on them. For example, items 1 and 5 could come together, or items 3 and 4 (we are working on item 2 and welcome contributions, but that may be a smaller task at this point). It depends on what you would like to focus on: writing new content or revamping existing content.
Let me know what you think. Cheers, - Melissa On Sun, Apr 18, 2021 at 9:31 AM Mukulika Pahari <mukulikapah...@gmail.com> wrote: > Hello everyone! > I am Mukulika Pahari, a Computer Engineering student from India. I wanted > to implement the following ideas for Google Summer of Docs 2021 if given > the opportunity. I have referred to both- the GSoD proposal > <https://github.com/numpy/numpy/wiki/Google-Season-of-Docs-2021-Project-Ideas#project-idea-high-level-restructuring-and-end-user-focus> > and the NEP 44 > <https://numpy.org/neps/nep-0044-restructuring-numpy-docs.html> proposal. > Please give me feedback about the ideas! > > > 1. > > Reorganising contents of the documentation into Reference Guide, > How-Tos, Tutorials and Explanations as per structure proposed in NEP 44 > <https://numpy.org/neps/nep-0044-restructuring-numpy-docs.html>. > > > - > > Auditing existing documentation > - > > Clearing misplaced content for example Explanations in Reference > Guide, How-Tos in Explanations etc. > - > > Establishing distinct Reference, How-Tos, Tutorials and Explanations > sections with crosslinking where required > > > 1. > > Reorganising landing page of NumPy docs <https://numpy.org/devdocs/>. > > > - > > Moving the documentation structure to the left sidebar > - > > Having NumPy Quickstart as the first thing people see when they land > on Documentation > > > 1. > > Writing new must-have tutorials (based on most-searched tutorials on > Google). > > > - > > “How to write a tutorial” guide > - > > 3 Beginner Tutorials > - > > 3 Intermediate Tutorials > - > > 3 Advanced Tutorials > > > 1. > > Writing How-Tos based on most-used functions, most asked doubts on > StackOverflow, etc. > 2. > > Revamping the User Guide. > > > - > > Updating out-of-date references and refactoring content to the latest > best practices > - > > Adding non-textual images or graphics to enhance the textual > explanations > - > > Removing duplication to improve searchability > > > I have proposed this work keeping in mind 30ish weeks of work including > a few weeks for becoming familiar with the organisation and ironing out > details like exactly which tutorials and how-tos to write. Please let me > know if I can aim to achieve more in the timeframe. > > My experience with NumPy is currently limited to one data analysis project > but I would love to learn more about its applications while restructuring > and developing its docs! > > Thank you for your time. > _______________________________________________ > NumPy-Discussion mailing list > NumPy-Discussion@python.org > https://mail.python.org/mailman/listinfo/numpy-discussion >
_______________________________________________ NumPy-Discussion mailing list NumPy-Discussion@python.org https://mail.python.org/mailman/listinfo/numpy-discussion
