Documentation at docs.einsteinpy.org needs updates

[JeS24]

🐞Problem

The docs are partially outdated. This issue is intended to track all the problems and fix them successively.

• ⭐ API docs need improvements (general language and grammatical) ➡️ Moved to Documentation overhaul #630.
• See API docs don't list down all the available modules on it's homepage #540.
• The example on the landing page uses perihelion which does not exist. Use precession.
• Blog points to https://docs.einsteinpy.org/
• ⭐ The changes to the user_guide / Introduction in the latest / 0.5.0dev version needs to be backported to stable / 0.4.0, since the code behaviour is the same between these versions. This has been a source of several issues recently.

📋Steps to solve the problem

People, who are interested in contributing, can pick up one or multiple of the issues listed above and open a corresponding PR. Also see: https://github.com/einsteinpy/einsteinpy/blob/main/CONTRIBUTING.rst.

• Comment below about what you've started working on.
• Add, commit, push your changes
• Submit a pull request.
• Add this in the comments:
  • Addresses #<put issue number here> if you are partially fixing the issue.
  • Fixes #<put issue number here> if you are completely fixing the issue.
• Ask for a review in comments section of pull request
• Celebrate your contribution to this project 🎉

[sagar-ksahoo]

Hi, I am willing to work on the API docs improvement. Could you elaborate on what is required so I can work on it?

[JeS24]

Hi @sagar-ksahoo. I have moved that part of this issue to its own separate issue - #630. I think, I have added sufficient details there. Please check it out and feel free to ask for clarifications.

[VigneshRamanathan101]

Is this issue still open?

[JeS24]

@vigneshRamanathan3105 Yes.

[VigneshRamanathan101]

What documentation needs to be updated now ?

[JeS24]

What documentation needs to be updated now ?

See issue #630, e.g., the docs at https://docs.einsteinpy.org/en/latest/api/symbolic/symbolic_index.html could use more verbosity and examples.

[J268sing]

I have started working on The changes to the user_guide / Introduction.

[JeS24]

I have started working on The changes to the user_guide / Introduction.

@J268sing The changes for those files are already there on main (latest). They need to be backported to 0.4.0 (stable). Is that what you're working on?