Open points to discuss with documentation team

[jonas-rem]

We noticed the following points need further discussion while reviewing PRs. We should discuss this with the documentation team to understand the previous context of those decisions.

• [ ] Emphasizing words where it brings no benefit to the reader https://github.com/phytec/doc-bsp-yocto/issues/13#issuecomment-1401694578_
• [ ] Using named links https://github.com/phytec/doc-bsp-yocto/pull/13#discussion_r1086703123_
• [ ] Should there be external documents/Links that e.g. explain Phytec's general Documentation structure (Chapter: "PHYTEC Documentation")? https://github.com/phytec/doc-bsp-yocto/pull/15#discussion_r1100466255
• [ ] In the pdf documents, there is a release version right below the title. This is the one from conf.py. I do not think this should be included in the pdf
• [x] One page html vs. numbered headings vs. multiple page html layout https://github.com/phytec/doc-bsp-yocto/pull/13#pullrequestreview-1269293114_

[mschwan-phytec]

@jremmert-phytec-iot Do you want to discuss this with the documentation department in person or via this issue?

[jonas-rem]

@jremmert-phytec-iot Do you want to discuss this with the documentation department in person or via this issue?

I think it would be best to discuss with them in person as a first step. But before that, let's merge the initial drafts of the Yocto documentation and the BSP documentation so that we have something to show. This issue should serve as a reminder of all open issues, feel free to add points.

[s-hemer]

IMHO emphasizing paths, commands and variable names in inline texts (and elsewhere) does bring a benefit to the reader. Somehow unfortunate that i.e. :file:`~/linux-imx/arch/arm64/boot/dts/freescale/|dt-carrierboard|.dtb` does not allow substitution.