search

phytec / doc-bsp-yocto

Yocto BSP Documentation
https://phytec.github.io/doc-bsp-yocto/
1 stars 1 forks source link

RFC: add pdf download links to all manuals #204

Open jonas-rem opened 2 months ago

jonas-rem commented 2 months ago

This PR adds the option to download a manual as a pdf file.

Currently there are two issues with the pdf files:

  1. The release in the pdf files is the documentation release (e.g. imx8mp-pd24.1.2-2-gb7c1ba7). This is confusing for customers that e.g. view an imx93 manual with that release string. Renaming the release string from Release to Documentation Build may reduce confusions.
  2. When providing pdf documents for head versions, we should probably mark them clearly to indicate that those are not final releases.

Note: As this PR is based on #203, you can review the pdf download feature with the documentation preview down in the checks.

To all Reviewers: Do you see a benefit to our customers by providing pdf files in this way?

s-hemer commented 2 months ago

The version string is indeed confusing. Although, I do not have a direct idea how to solve it, I am pretty sure that both issues can be solve in one step.