Documentation Simplified
Showing 3 of 3 projects. Click any project card for scope, mentors, and proposal studio.
Mentors: Student: Maksudul Haque(saadmk11)
<p>This project involves automatically building docs for Pull Requests in GitHub repositories that Read the Docs users have. This will include modeling pull requests as versions, building an integration with Github, storing the generated docs in long term storage, Deleting pull request Docs when merged or after a certain period of time and many other possibilities that might arise while working on this.</p>
Mentors: Student: Vaibhav (dojutsu-user)
<p>Searching is an important part of Read the Docs. This project aims to implement new features on the existing search backend, which are as follows:</p> <ul> <li><strong>In-Doc Search UI</strong>: Creating an Sphinx extension which provides a full-page search UI with "search as you type" capability.</li> <li><strong>Multiple Hits Per Search Result</strong>: Support results from sections of the docs.</li> <li><strong>Code Search</strong>: Index sphinx domain objects properly and improve the UI/UX around its search.</li> <li><strong>Search Analytics</strong>: Provide search analytics to the project admins.</li> </ul>
Mentors: Student: Safwan Rahman
<p>This project is to improve the search functionality of Read the Docs so that the users of readthedocs can get relevant information from the search. Moreover, rewriting the code in order to use latest version of Elasticsearch and officially supported library. This will help the platform developer to maintain the search code easily also help the user to get more useful search result.</p>