Updated README.md

[jaidh01]

Description

This update revamps the README.md file for the FaceRec project to improve clarity and structure. The changes enhance user engagement and address issue #55 related to documentation quality.

Fixes #55

Type of change

Please delete options that are not relevant.

• [x] New feature (non-breaking change which adds functionality)

How Has This Been Tested?

Changes were verified by reviewing the rendered output of the updated README.md on GitHub. Tests included:

• [x] Checked formatting and links.

Checklist:

• [x] My code follows the style guidelines of this project
• [x] I have performed a self-review of my own code
• [x] I have commented my code, particularly in hard-to-understand areas
• [x] I have made corresponding changes to the documentation
• [x] My changes generate no new warnings
• [x] I have added tests that prove my fix is effective or that my feature works
• [x] New and existing unit tests pass locally with my changes
• [ ] Any dependent changes have been merged and published in downstream modules

[senior-dev-bot[bot]]

Hi there! :wave: Thanks for opening a PR. :tada: To get the most out of Senior Dev, please sign up in our Web App, connect your GitHub account, and add/join your organization Devasy Patel. After that, you will receive code reviews beginning on your next opened PR. :rocket:

[Devasy23]

@jaidh01 the pre-commit hook messed with the requirement.txt maybe that's why the pipeline isn't passing.

DEBUG that issue and if you can revamp some changes to the sphinx doc as well then I'll assign this ticket, level2 tag

[Devasy23]

Everything else looks good to me, wbu @devansh-shah-11 ?!

[jaidh01]

Hi @Devasy23, I have done all the changes as you suggested. Please spare a time to review it.

[Devasy23]

You still need to add the sequence diagram

[jaidh01]

You still need to add the sequence diagram

I have already added it.

[Devasy23]

And are you looking forward to add this changes to the sphinx documentation also, that is in the .rst files from docs/

[jaidh01]

@Devasy23, could you please guide me through updating the Sphinx documentation? I have no prior experience with this, but I am eager to learn.

[Devasy23]

Hi @jaidh01 ,

Thank you for updating the README.md. To ensure consistency across our documentation, I'd like those changes to be reflected in our Sphinx documentation as well.

Sphinx is a powerful tool for generating documentation, typically used for Python projects. It processes .rst (reStructuredText) files, but you can also include Markdown files like README.md with a few configurations. Here’s a quick overview of what you'll need to do:

1. Install necessary extensions:

Sphinx doesn't support Markdown out of the box, but you can add support for it with extensions. Please install recommonmark and myst-parser, two popular extensions for parsing Markdown files:

pip install recommonmark myst-parser

2. Update conf.py:

In the Sphinx configuration file (conf.py), you’ll need to enable these extensions. Add or update the following lines in the file:

extensions = ['recommonmark', 'myst_parser']

To automatically include the README.md, add this:

source_suffix = { '.rst': 'restructuredtext', '.md': 'markdown', }

3. Include README.md in your index.rst:

In the index.rst (or wherever appropriate in your documentation), include the README.md file like this:

.. include:: ../README.md :parser: myst

This will ensure that the changes from the README.md are parsed and included in the Sphinx-generated documentation.

References:

Sphinx official documentation: https://www.sphinx-doc.org/

Guide on using Markdown with Sphinx: https://myst-parser.readthedocs.io/

recommonmark GitHub repo: https://github.com/readthedocs/recommonmark

Let me know if you need any further clarification!

[Devasy23]

Any update on this @jaidh01 ?

[Devasy23]

Any update on this @jaidh01 ?

[jaidh01]

Any update on this @jaidh01 ?

I will update the sphinx docs by today evening.

[jaidh01]

Hi @Devasy23, I have updated the sphinx docs. And in the code, there was only single line change in the index.rst file. Where I just add this line: - :parser: myst at the end.

So, should I commit it or leave it?

[Devasy23]

@jaidh01 please take pull from main branch to solve conflicts

[senior-dev-bot[bot]]

Hi there! :wave: Thanks for opening a PR. It looks like you've already reached the 5 review limit on our Basic Plan for the week. If you still want a review, feel free to upgrade your subscription in the Web App and then reopen the PR

[jaidh01]

@jaidh01 please take pull from main branch to solve conflicts

I have taken the pull from the main branch, and I think it should now resolve the conflicts.

[Devasy23]

@jaidh01 please take pull from main branch to solve conflicts

I have taken the pull from the main branch, and I think it should now resolve the conflicts.

Cool,

• I saw you sphinx changes but there aren't any, the readthe docs isn;t still parsing README.md file.

• You haven't put seq diagram, just the plantuml code that LLM generated.