Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: replace index.md with symbolic link to README.md #154

Open
wants to merge 6 commits into
base: main
Choose a base branch
from

Conversation

iprasannamb
Copy link

This PR replace index.md with symbolic link to README.md

Pull Request Checklist

The PR is

  • Symbolic link
  • Document Update

About this PR:

  • Documentation has been updated
  • No unnecessary changes have been introduced

Author's checklist:

  • I have reviewed the changes and it contains no misspelling.

Copy link
Member

@xmnlab xmnlab left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! thanks @iprasannamb

Copy link
Member

@Saransh-cpp Saransh-cpp left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This leads to a

UndefinedError: 'env' is undefined

error in the rendered docs. See #140 for a fix.

@xmnlab
Copy link
Member

xmnlab commented Mar 10, 2025

good catch @Saransh-cpp , appreciate that!

@iprasannamb, as mentioned by @Saransh-cpp , you will need to apply the same changes from here #140 to the README.md file

@iprasannamb iprasannamb reopened this Mar 10, 2025
@iprasannamb
Copy link
Author

@xmnlab , @Saransh-cpp As you mentioned about the changes , I've made the changes in README.md

iprasannamb and others added 2 commits March 10, 2025 17:37
Co-authored-by: Saransh Chopra <[email protected]>
Co-authored-by: Saransh Chopra <[email protected]>
Copy link
Member

@Saransh-cpp Saransh-cpp left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, @iprasannamb!

@xmnlab
Copy link
Member

xmnlab commented Mar 12, 2025

@iprasannamb , thanks for working on that.
could you rebase your branch on top of the upstream main and after that, rerun the linter locally?

pre-commit run --all-files

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants