Documentation Update and Restructure : remaining tasks

[arnopo]

Based on #37, the aim of this issue is to list items that should be addressed in the scope of the documentation restructuring. This list needs to be discussed and can potentially be extended with new comments.

Reference of the documentation used as input: https://openamp.readthedocs.io/en/main-next/

• https://openamp.readthedocs.io/en/main-next/openamp/overview.html#openamp-architecture

  • Proxy and RPC chapter should be renamed Rpmsg service . to discuss if we keep the proxy service that is not generic.

• https://openamp.readthedocs.io/en/main-next/openamp/overview.html#project-aims

  • move chapter before fundamentals,
  • to rewrite this chapter ( remove standardization notions).

• https://openamp.readthedocs.io/en/main-next/openamp/overview.html#operating-environments

  • improve the form and update list of supported RTOS
    addressed in A few fixes on top of the main-next branch #39

• https://openamp.readthedocs.io/en/main-next/openamp/overview.html#openamp-governance-and-guidelines

  • add link to the virtio spec
  • move "If you want to contribute and port OpenAMP to your platform read more about OpenAMP porting here." to contributing page

• https://openamp.readthedocs.io/en/main-next/openamp/contributing.html

  • Avoid duplication with https://www.openampproject.org/governance/ in this pages. to determine if a part of the gouvernance should be moved ghere

• https://openamp.readthedocs.io/en/main-next/openamp/contributing.html#roadmap-discussion-and-publication

  • no roadmap defined, to remove chapter

• https://openamp.readthedocs.io/en/main-next/openamp/contributing.html#platform-maintainers

  • no platform maintainer defined, to remove chapter and/or rewrite according to gouvernance page

• https://openamp.readthedocs.io/en/main-next/demos/demos_index.html

  • for all examples:
    • to remove resource table reference ( except for https://openamp.readthedocs.io/en/main-next/demos/rpmsg_multi_services.html)
      Changes A for Issue 38 #41
    • the RPMsg and the load of the coprocessor are independent. Remove "once loaded and started using Remoteproc."
      Changes A for Issue 38 #41
    • replace remoteproc by remoteproc virtio in message diagrams. the remoteproc virtio is the virtio transport layer ( similar to virtio MMIO)
    • change reference to code from opena-amp repository to openamp-system repository
      Changes A for Issue 38 #41

• https://openamp.readthedocs.io/en/main-next/protocol_details/index.html

  • legacy document with specific Xilinx boards, we should have something more generic.

• https://openamp.readthedocs.io/en/main-next/protocol_details/components.html

  • "History" to move to OpenAMp project part?
  • "Proxy and RPC" should be part of examples?
    Changes A for Issue 38 #41

• https://openamp.readthedocs.io/en/main-next/open-amp/doc/remoteproc-design.html

  • point to API page generated by doxygen, instead of duplicating the API

• https://openamp.readthedocs.io/en/main-next/open-amp/doc/rpmsg-design.html

  • point to API page generated by doxygen, instead of duplicating the API

• https://openamp.readthedocs.io/en/main-next/docs/data_structures.html

  • point to API page generated by doxygen, instead of duplicating the API

• demos/reference_boards.rst

• NXP i.MX8M Plus was also added
  Documentation Update and Restructure #37 (comment)

• demos/rpmsg_multi_services.rst

• NXP i.MX8M Plus is also supported.
  Documentation Update and Restructure #37 (comment)

• Complete Glossary

  • Add glossary items: OAOS, OAPI, OALK, Linux Flat Image Tree (FIT)
    Documentation Update and Restructure #37 (comment)

• openamp/overview.rst

• Add PMM for hypervisorless virtio in architecture (openamp/overview.rst) ?

• sync on an appropriate rephrasing.
  Documentation Update and Restructure #37 (comment)

• rpmsg_protocol.rst

  • consolidate terminology for ring buffer
    "input ring buffer" and "free ring buffer" is not really current terminology in Virtio lingo. Maybe just keep the standard used and available terminology.
    Documentation Update and Restructure #37 (comment)
  • clarify ring buffer image
    It's not clear from the title of this image that it refers to the available ring buffer.
    Documentation Update and Restructure #37 (comment).

Repositories that no more up to date and need clean up

• https://github.com/OpenAMP/openamp-docs/tree/main/future
• https://github.com/OpenAMP/openamp-docs/tree/main/current