[agl-dev-community] GSoD Weekly Update: Week 3

["Shankho Boron Ghosh" <shankhoghosh123@xxxxxxxxx>]

Week 3 :
--------------

-   Finalizing Theme :
    -   Completed with the selection of the theme for the doc site.
Windmill [1] 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 [1] also supports the default readthedocs version
menu after some tweaks using this StackOverflow [2] reference.
    -   Since the static site generator is mkdocs which supports
searching, out-of-the-box with use of the client-side lunar.js [3]
search engine as a MkDocs plugin [4].
    -   Customized the doc-site's color [5] to AGL's blue and green
theme, with inputs from the mentor.
    -   Tried [6] and stuck customizing the AGL logo and favicon onto
the site which is unfortunately overridden by readthedocs.
    -   Submitted [7] these changes to documentation Gerrit repository
[8] kindly initiated by Jan-Simon.

-   Documentation Development :
    -   Started going through the whole documentation to find holes
and possible restructuring.
    -   Initialized a new doc development directory "ATTIC" [9], where
the docs in development would be stored.
    -   Also, Jan-Simon was kind enough to provide me a Raspberry Pi 4
kit [10] and a UART to USB serial connector [11] which I plan to use
for verifying and updating the content of the docs.

[1] : https://github.com/gristlabs/mkdocs-windmill
[2] : https://stackoverflow.com/questions/37952916/can-i-use-external-themes-with-mkdocs-on-readthedocs-org
[3] : https://lunrjs.com/
[4] : https://github.com/growupboron/agl-docs/blob/master/mkdocs.yml
[5] : https://github.com/growupboron/agl-docs/commit/2ff70f644203833d8789ef89f0f458ba5bb187e4
[6] : https://github.com/growupboron/agl-docs/commit/9bda6cd6c296b754ca78bc1e0363d5f4a1197533
[7] : https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/25236
[8] : https://gerrit.automotivelinux.org/gerrit/admin/repos/AGL/documentation
[9] : https://github.com/growupboron/agl-docs/tree/master/docs/ATTIC
[10] : https://www.amazon.in/India-Raspberry-Official-Heatsink-Ethernet/dp/B07XH47F8L/
[11] : https://www.amazon.in/Robocraze-PL2303HX-RS232-Module-Converter/dp/B077NC9895

Regards,
Shankho Boron Ghosh
Junior, Electronics & Communication Engineering
Thapar Institute of Engineering and Technology
+91 9819674639
https://growupboron.github.io/

-=-=-=-=-=-=-=-=-=-=-=-
Links: You receive all messages sent to this group.

View/Reply Online (#8640): https://lists.automotivelinux.org/g/agl-dev-community/message/8640
Mute This Topic: https://lists.automotivelinux.org/mt/76828295/2167316
Group Owner: agl-dev-community+owner@xxxxxxxxxxxxxxxxxxxxxxxxx
Unsubscribe: https://lists.automotivelinux.org/g/agl-dev-community/leave/4543822/883735764/xyzzy  [list-automotive-discussions82@xxxxxxxxxxx]
-=-=-=-=-=-=-=-=-=-=-=-