-
Notifications
You must be signed in to change notification settings - Fork 0
GSoD '21 Weekly Updates
The first phase was to do an audit of the User Guide and Reference to find out duplicate content, missing links etc. I read the Diataxis framework documentation thoroughly for this task. I got started with a template inspired by ESLint's past GSoD project. I finished auditing the first 4 pages of the User Guide. I wanted to become fluent with the development process simultaneously so I also solved a beginner-friendly issue (#7992).
There was a Documentation meeting on Monday where we discussed updating the Building NumPy API and reference docs. I made an issue detailing the requirements and submitted a PR against it during the week (#19104). I made another PR to address the missing links that I found in the process of the audit (#19115). I also set up a project board in my fork of the repo to keep track of the issues and pull requests I was making. At the end of the week, I opened another issue to plan the merging of two duplicate docs for array broadcasting (#19136). I finally got around to writing a draft for my blog, detailing my application process.
Published my first GSoD blog on Medium and dev.to. Completed 90% of the User Guide audit.
Attended Documentation team meeting where we discussed opening issues for the next phase. Opened issues #1 and #2 in my fork to discuss audit report findings.
This week we continued discussion on which pages are to be restructured/rewritten. I opened issue #3 to discuss the indexing documents. The other two documents do not need a refactor right now according to the discussions. I also finished up PR #19128 to finish rewriting Building the NumPy docs and API reference. Next week I'll try to get a consensus on the Indexing documents and start working on that and the Broadcasting documents rewrite.
We discussed about looking into the NumPy Random module docs in this week's documentation meeting. I worked on issue #19136 this week and closed issue #19313.
This week I worked on issues #14038 and #19136. The Broadcasting docs have been halfway merged. Next week I will add the SVGs and remove the remaining content from the orphan doc. I have finished the majority of the merge for the Indexing docs as well and will do review iterations next week.
This week we discussed about moving the Indexing page entirely to the Fundamentals section. After finalising that, I will probably finish it up next week. I learnt how to use Inkscape and ported all the diagrams into the Broadcasting doc (#19369). Next week I have plans to start working on the Ufuncs docs (#16924).