Skip to content

Innovation Sprint - RTD Improvements

Ugur Yilmaz requested to merge customise-theme into master

Please give feedback! Much appreciated!

You can see changes following the "View App" in the pipeline of this MR or

What's your idea?

Have a easy to navigate and more feature-rich developer portal.

To do this, I'll add:

  • feedback buttons/forms
  • last edit time
  • better TOC
  • better contribution system
  • copy button for code snippets (Sept 22)

Current Progress

See checklist above for the progress.

Currently, I have added a feedback section at the end of the pages, added a right-side TOC if the screen is wide enough and changed the edit buttons.

Feedback: Integrates with GitLab issues; opens a new issue page with populated description and title from RTD using the user's account. This could be changed with a more robust feedback mechanism (that doesn't need the user to log in to GitLab and create the issue).

What will this improve?

Users will be able to navigate more freely and contribute more to the pages and provide feedback. This will make developer portal a little bit more interactive.

What technologies do you plan to make use of?

Readthedocs api, html/css, python

What support do you need?

HTML/CSS/Javascript

Interested Collaborators

None

Edited by Ugur Yilmaz

Merge request reports