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: moved from ipnb files to md files #1482

Merged
merged 15 commits into from
Oct 14, 2024

Conversation

jjmachan
Copy link
Member

@jjmachan jjmachan commented Oct 13, 2024

From now on documentation will be expected to written as .md files

we have a script to do the conversion make ipynb-to-md that will do the conversion.

  • all generated md files should be have the _ prefix so that we know it's a converted files and generated md files are not expected to be edited manually.
  • We can now use all the md formats available (but should have worked otherwise too)
    image

you can visualize the diff here

Do compare them side by side before merging

@dosubot dosubot bot added the size:XXL This PR changes 1000+ lines, ignoring generated files. label Oct 13, 2024
@jjmachan jjmachan requested a review from shahules786 October 13, 2024 04:39
Copy link
Member

@shahules786 shahules786 left a comment

Choose a reason for hiding this comment

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

There are places in which the these ipynb files were linked to which have to be changed. For example https://ragas--1482.org.readthedocs.build/en/1482/howtos/customizations/
Links under metrics does not work.

@jjmachan jjmachan enabled auto-merge (squash) October 14, 2024 21:11
@jjmachan jjmachan merged commit 4cfa6b1 into explodinggradients:main Oct 14, 2024
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
size:XXL This PR changes 1000+ lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants