DOC: Refactor README

[giovaniceotto]

Pull request type

• ReadMe, Docs and GitHub updates

Checklist

• Docs have been reviewed and added / updated

Current behavior

• Header logo is broken, using restructured text syntax instead of html/markdown.
• Some badges are irrelevant, while relevant ones are missing.
• Institutional collaborators such as Projeto Jupiter and Space Enterprise at Berkeley are not properly recognized.

New behavior

• Header logo fixed, maintaining support for light and dark mode. HTML was needed to accomplish this, as specified in Specifying the theme an image is shown to
• Build status badge was removed.
• Instagram badge was added.
• New Institutional Contributors section added to recognize all teams that collaborate with RocketPy. Their logos are kept under /docs/static/institutional

Breaking change

• No

[Gui-FernandesBR]

Good improvement, @giovaniceotto !

The images are not rendering to me when I build the docs here. Could you confirm if these are working for you? Dark mode also have the same behavior

[Gui-FernandesBR]

link to the readthedocs: https://docs.rocketpy.org/en/docs-refactor-readme/

The rocketpy logo is still not working.

[giovaniceotto]

Good catch! I'll attempt a simple fix by the end of the day, trying to link the images using raw blobs. However, in the long run, we need to unlink our Docs homepage from our ReadMe. I would leave that for a separate PR so that we can merge this one soon.

[Gui-FernandesBR]

Good catch! I'll attempt a simple fix by the end of the day, trying to link the images using raw blobs.

However, in the long run, we need to unlink our Docs homepage from our ReadMe. I would leave that for a separate PR so that we can merge this one soon.

OK, I agree if you suggest to remove the README.md from the docs. Maybe we could copy the same style as in Numpy and Pandas' docs:

• https://numpy.org/doc/stable/
• https://pandas.pydata.org/docs/

But for this PR what I think you could do is this:

![Logo Dark](https://image-link.png#gh-dark-mode-only)
![Logo Light](https://image-link.png#gh-light-mode-only)

The #gh-dark-mode-only tag is the way github identifies the style in the page.
It doesn't work out of github (in the docs, for instance).
But it will work just fine here.

Opening an issue for the first task is recommended

[giovaniceotto]

But for this PR what I think you could do is this:

Unfortunately, that is already deprecated. GitHub will not support that anymore soon, as outlined in the link available in the PR description.

That being said, I do not believe the HTML tags are the problem. The problem is only the link.

[giovaniceotto]

@Gui-FernandesBR, this is ready for final review. Here are a couple of notes:

• I had to remove all the display flex used to align images in the same line since GitHub seems not to support it (even though RTD does)
• I separated the trajectory and the KML images, since moving the trajectory plot down made the text lose sense.
• I already mapped all images to their master branch location, as they were merged via DOC: Static images #420

[Gui-FernandesBR]

A masterpiece, as expected from a master.

Thank you so much for fixing the errors, @giovaniceotto !!

[Gui-FernandesBR]

FYI,

docs still not rendering some images correctly here:

[giovaniceotto]

Seems to be an issue with dark and light mode theme.

From what I understand right now, GitHub and RTD handle an image for each them differently. We fixed it on GitHub, and now it's broken on RTD.

RTD seems to be using the image considering the browser color theme. However, it also has it's own theme toggle, which does not update the image. That confuses thinks.

I'll attempt to investigate further.

[Gui-FernandesBR]

Maybe the conf.py of sphinx has an option to toggle which theme is the deafult