Re: [Numpy-discussion] Google Summer of Docs Faq and Tutorial Proposed Structure .
Hello Melissa , I have altered and built upon my previous proposal , if you could take a few minutes to read it it would be great . I have tried to explain the sections we had discussed in the meeting on 22 June .
Moreover as per your feedback , I would like to start contributing to the docs and start building the docs in my Linux environment .
Best , Mrinal Tyagi
On Wed, 24 Jun 2020 at 2:36 PM, Saber Tooth email@example.com wrote:
Hello Melissa and all the Mentors ,
In the last meeting of NumPy Docs held on June 22nd , I had Proposed Tutorial and Faqs structure , where it was discussed how we should include them in the new structured Documentation . Now after a lot of Googling I have been able to provide a structured solution It is very important for us to include the FAQs section , but why ? If we see how many views some questions on Stack overflow https://stackoverflow.com/questions/tagged/numpy?tab=frequent&page=1&... have got the answer is obvious , the 1st page itself has garnered some 4-5 *million *views and there are really many questions . It means if we are able to answer some of these questions ,not necessarily the exact questions , it would be really good for the Docs .
I have tried to break the FAQs page into sections so that everything is not cramped onto one page and we have good docs as per SEO guidelines . I have structured based on best practices for the FAQs section : https://www.shivarweb.com/9665/faq-page-best-practices/ .
I have improved further upon my previous proposal , please have a look. Eagerly waiting @Melissa Mendonça firstname.lastname@example.org @Ralf Gommers email@example.com for your feedback on the same , I would be obliged if you have some ideas which could be incorporated with the same or built upon these .
Link to Proposal : https://docs.google.com/document/d/1q-BYO-GqlBIsMizCzjbANORz6OOaC-6oEzuE1_Hq...
Link to FAQs Proposed structure : https://docs.google.com/document/d/1q-BYO-GqlBIsMizCzjbANORz6OOaC-6oEzuE1_Hq...
Link to Tutorials Proposed structure : https://docs.google.com/document/d/1q-BYO-GqlBIsMizCzjbANORz6OOaC-6oEzuE1_Hq...
Thanks , Mrinal Tyagi