Improve README documentation#51
Open
anishaachaudhuri wants to merge 1 commit into
Open
Conversation
Owner
|
@anishaachaudhuri , give these SS : which are told in current README.md section ,... see it . and also give live netlify link and all , SEE where current README.md lags and ful fill it , plz REVISIT .... |
Author
|
@AnirbansarkarS I’ve made the changes. As mentioned earlier, I’m unable to log in on the deployed link, and the app also isn’t running locally due to some dependency-related issues. Because of that, I’ve added:
You can check everything here in the fix-readme branch: |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
This PR improves the README by adding:
The README previously contained placeholder sections for visuals, so these additions help provide better project verification and improve overall documentation quality.
I was unable to access internal pages like the Library Dashboard, Community, and Stats due to a local issue likely related to version compatibility or Supabase authentication. Otherwise, I would have added screenshots for those sections as well.
No existing README content was removed — all original sections/placeholders were preserved, and the new visuals were added alongside them.