Difference between revisions of "BeagleBoard/GSoD/Ideas-2023"

From eLinux.org
Jump to: navigation, search
 
Line 17: Line 17:
 
==Volunteers==
 
==Volunteers==
  
==Contact info===
+
==Contact info==
 
* Technical writers interested in working on this project should send an email to lorforlinux [at] beagleboard.org . Please include links to your technical writing work or portfolio/résumé/CV.
 
* Technical writers interested in working on this project should send an email to lorforlinux [at] beagleboard.org . Please include links to your technical writing work or portfolio/résumé/CV.

Latest revision as of 12:56, 24 March 2023

Project Idea: Optimize docs PDF

Problem

  • Current documentation is using sphinx to create static site and a PDF of the entire documentation. The PDF is very large in size and it's not convenient for users to download. Reason for large PDF is huge PNG and JPG images.

How would we measure success?

  • Add full support for SVG images.
  • Optimze PNG/JPG images.
  • All rasterized images use Webp format.
  • Remove redundant content.
  • Reduce the PDF size by atleast 20%.

What skills would a technical writer need to work on this project?

  • Must have: git and GitHub/GitLab experience,
  • Nice to have: Knowledge of Sphinx, RST, and image optimization tools.

Volunteers

Contact info

  • Technical writers interested in working on this project should send an email to lorforlinux [at] beagleboard.org . Please include links to your technical writing work or portfolio/résumé/CV.