canonical/open-documentation-academy

Ulwazi theme: Design the Get help side panel

Aperta

#356 aperta il 17 lug 2026

 (6 commenti) (0 reazioni) (1 assegnatario)Python (99 fork)auto 404
codedesigngood first issuesize 3ulwazi

Metriche repository

Star
 (119 stelle)
Metriche merge PR
 (Metriche PR in attesa)

Descrizione

Mentor

The mentor for this issue is @izmalk. They are the Technical Author responsible for the Ulwazi theme development.

Background

Ulwazi is our new theme for all Canonical documentation that is under active development. It's design is based on the Vanilla Framework.

See the demo website and usage instructions at the https://documentation.ubuntu.com/ulwazi/ address.

Prerequisites

This issue requires context about Ulwazi usage and development. The main prerequisites are:

  1. Basic knowledge about Git and web frontend development.
  2. You have forked and cloned the Ulwazi repo
  3. You have successfully built the docs at your local machine
  4. You have read the Contribution guide

Learnings

Upon completion, you will learn:

  • The basics for Ulwazi theme development
  • Vanilla Framework basics
  • How to contribute to Ulwazi theme

Task

  • Build prototypes: choose a few options and build alternative design prototypes. Mostly variating the location. Baseline should by bottom right (after the local table of contents).
  • Discuss prototypes: initiate a discussion of the protoypes with the mentor and anyone interested in the original issue. Based on the discussion, select the best option.
  • Implement the final design. Make sure it's configurable through conf.py. By default (nothing in the conf.py) - no new side panel is visible. The conf.py let's us customise the side panel to adjust it's title and content. The content is just a list of links.
  • Sumbit a PR for a review, add a comment to the original issue with the link to the PR
  • Pass a review and enjoy your results merged in the main branch and published

Outcome

Nicely looking and mostly Vanilla Framework compliant side panel Get help / Additional resources in our sample docs for both MyST and RST syntax.

Resources

Guida contributor