<div dir="ltr"><div dir="ltr">On Tue, Jul 16, 2019 at 12:48 AM Dashamir Hoxha <<a href="mailto:dashohoxha@gmail.com">dashohoxha@gmail.com</a>> wrote:<br></div><div class="gmail_quote"><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left:1px solid rgb(204,204,204);padding-left:1ex"><div dir="ltr">Hi,<div><br></div><div>With respect to this call for contributions: <a href="https://github.com/numpy/numpy/pull/13988/files" target="_blank">https://github.com/numpy/numpy/pull/13988/files</a></div><div>I would like to help with improving the website of numpy (and maybe scipy as well).</div><div>I have also applied for the Google Season of Docs 2019, and if accepted, I will be starting by the beginning of August.</div><div><br></div><div>The improvements that I would like to make include:</div><div>- Making the website responsive (so that it looks nice on small screens as well). There are responsive themes for sphinx and I may use one of them.</div><div>- Improving the main page (or the landing page) so that it looks a bit more modern and attractive.</div><div>- Reorganizing the structure of the information on the website, so that people from different backgrounds (students, professionals, etc.) can find more easily the relevant information that they are looking for. Including references to the external tutorials or courses about NumPy/SciPy.</div></div></blockquote><div><br></div><div>Has anybody tried Katacoda before: <a href="https://www.katacoda.com/courses/python/playground">https://www.katacoda.com/courses/python/playground</a> ?</div><div>It can be used to develop interactive tutorials, which can also be embedded on a web page.</div><div>I may also write a couple of beginners' tutorials (based on the existing tutorials), if this seems to be useful.</div><div> </div><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left:1px solid rgb(204,204,204);padding-left:1ex"><div dir="ltr"><div><br></div><div>Other tentative improvements may be these:</div><div>- Reorganize the docs so that each major release has its own version of docs. Major releases are those that may introduce new features, or in general, changes in the API (minor releases are the maintenance releases, which fix bugs, or make small changes, for example to improve the efficiency, but do not change the API). For example major releases may be v1.15, v1.16, v1.17 (however I am not sure about this).</div><div>- Reorganize the docs so that the core API functionality is shown more prominently than the rest, and so that functions that may be deprecated in the future can be marked so (in order to discourage users from using them) and alternative solutions are suggested instead of them, etc.</div><div>- Allow the users to add comments for each function or package. These may be usage examples for the benefit of other users, or pitfall alerts, or even bug reports. Reporting bugs on GitHub is better of course, but this may be a bit easier for the users.</div><div><br></div><div>Since these are not incremental changes, if may be better if I work on a fork of the website repository, until they are finished and the new website is ready.</div><div><br></div><div>Regards,</div><div>Dashamir Hoxha</div></div>
</blockquote></div></div>