Week 3 :

• Finalizing Theme

  • Completed with the selection of the theme for the doc site. Windmill was finalized due to a clean and simple user interface with high responsiveness in mobile view and default collapsible navigation pane suiting AGL’s documentation index.
  • Windmill also supports the default readthedocs version menu after some tweaks using this stackoverflow reference.
  • Since the static site generator is mkdocs which supports searching, out-of-the-box with use of the client-side lunar.js search engine as a MkDocs plugin.
  • Customized the doc-site’s color to AGL’s blue and green theme, with inputs from the mentor.
  • Tried and stuck customizing the AGL logo and favicon onto the site which is unfortunately overridden by readthedocs.
  • Submitted these changes to documentation gerrit repository kindly initiated by the mentor (Jan-Simon).

• Documentation Development

  • Started going through the whole documentation to find holes and possible restructuring.
  • Initialized a new doc development directory “ATTIC”, where the docs in development would be stored.
  • Also, mentor (Jan-Simon) was kind enough to provide me a Raspberry Pi 4 kit and UART to USB serial connector which I plan to use for verifying and updating the content of the docs.