search

stanfordnlp / dspy

DSPy: The framework for programming—not prompting—language models
https://dspy.ai
MIT License
19.07k stars 1.46k forks source link

Docs Update: Minor Update to the order of concepts and renames #1680

Closed karthikscale3 closed 1 month ago

karthikscale3 commented 1 month ago

Another incremental minor update for the sake of better clarity. Shown below the pre post of the changes. Happy to revert back anything you feel is unnecessary. Also, these changes DO NOT affect the permalinks so it won't cause any breakages to existing links on the internet.

This PR also removes the duplicate assertions.md file inside modules as the same doc is available at the top level under concepts.

image

krypticmouse commented 1 month ago

It looks good for the most part but this might break google index in the short term, so I suggest to add some redirection links in mkdocs

Check #1681 for reference

Thank you so much for the contribution!!

karthikscale3 commented 1 month ago

It looks good for the most part but this might break google index in the short term, so I suggest to add some redirection links in mkdocs

Check #1681 for reference

Thank you so much for the contribution!!

Good call. This PR does not actually change the links. I verified it and it keeps the old links. I just added one redirect for the assertions doc inside deep-dive section which was duplicated so I removed it and added a redirect for it.

krypticmouse commented 1 month ago

Awesome! LGTM :ship:

Thank you so much for the contribution!!