Fixed formatting and added search functionality in documentation

[avinabneogy23]

This pull request addresses Issue #191 by improving the documentation formatting and introducing search functionality to enhance usability.

[avinabneogy23]

• Improve formating, sectioning, etc in general edit of docs #191

[StarTrooper08]

Hi Avinab,
Thanks for opening PR.
Right now we have to hold this PR. And resume it later on.

If you are looking to participate in GSoC.
Can you please go through the r-gsoc wiki page. You can find pretest for this project.

https://github.com/rstats-gsoc/gsoc2025/wiki/table-of-proposed-coding-projects

Thank you.

[hturner]

Just to echo what @StarTrooper08 said - if this is for GSoC, you should post a solution for Hard Test 1 that has a screenshot with (some of) your improved documentation deployed locally and a link to this PR.

[avinabneogy23]

Hi Heather and Atharva,

I opened this PR as a solution for the Hard test 1 and as you have mentioned, Heather I will be linking this to the solution along with the relevant screenshots.

Thanks for the guidance you guys !

[hturner]

@Avinab there are quite a few conflicts as I just merged a PR implementing the pre-commit markdown linter which did a lot of automated tidying (enforcing line length of 80 characters, ensuring code blocks are always fenced - e.g. with ```bash and ```). It would be great if you could resolve this conflicts so we can review your new changes.

[avinabneogy23]

Hi @hturner ,
I apologize for the multiple commits. As I'm new to documentation contributions, I encountered several linter issues that required iterative fixes.
Thanks!

[hturner]

We are also new to the pre-commit linter. But you should be able to install it to run the linter locally so you can fix things before committing, see https://pre-commit.com.

[avinabneogy23]

Hey Heather,
Thanks! I'll check out the pre-commit linter and get it running locally. Appreciate the suggestion and it will save me a lot of time !

[avinabneogy23]

Hey Heather,
I am closing this PR, will be opening separate PR for search (#212 ), documentation additions and formatting.
Thanks!