Validate README.rst files at PR time

[xrmx]

README.rst files are used for package description and are validated when uploading to pypi. If the README.rst is invalid the upload would fail as will do the release workflow. Since we can catch invalid READMEs earlier it would be nice to do that and avoid a cause of stress at release time.

[xrmx]

Looks like something like this may work:

pip install rstcheck

rstcheck --report warning --recursive instrumentation instrumentation-genai/ exporter opentelemetry-instrumentation/ util processor/ propagator opentelemetry-distro

[emdneto]

@xrmx rstcheck has pre-commit action, so we can use it I guess

[emdneto]

  - repo: https://github.com/rstcheck/rstcheck
    rev: f30c4d170a36ea3812bceb5f33004afc213bd797 # frozen: v6.2.4
    hooks:
      - id: rstcheck
        additional_dependencies: [sphinx]
        exclude: testing

[Binita-16]

Can you please assign this to me, if not already solved

[xrmx]

@Binita-16 If you have time to work on this just add a comment here and we'll consider the issue assigned to you for a week.