openai-cookbook icon indicating copy to clipboard operation
openai-cookbook copied to clipboard

Fix: Broken links in related_resources.md and README.md

Open iamarunbrahma opened this issue 10 months ago • 1 comments
trafficstars

Summary

This PR fixes broken documentation links in related_resources.md and examples/vector_databases/README.md. The changes ensure all external documentation links are up-to-date and functional, improving the cookbook's reliability and user experience.

Motivation

Several documentation links in our repository were outdated or broken due to external documentation restructuring by various providers. These changes were necessary to:

  1. Ensure users can access the correct documentation resources
  2. Maintain the cookbook's quality and reliability
  3. Reduce user frustration from encountering broken links

For new content

When contributing new content, read through our contribution guidelines, and mark the following action items as completed:

  • [ ] I have added a new entry in registry.yaml (and, optionally, in authors.yaml) so that my content renders on the cookbook website.
  • [x] I have conducted a self-review of my content based on the contribution guidelines:
    • [x] Relevance: This content is related to building with OpenAI technologies and is useful to others.
    • [ ] Uniqueness: I have searched for related examples in the OpenAI Cookbook, and verified that my content offers new insights or unique information compared to existing documentation.
    • [x] Spelling and Grammar: I have checked for spelling or grammatical mistakes.
    • [x] Clarity: I have done a final read-through and verified that my submission is well-organized and easy to understand.
    • [x] Correctness: The information I include is correct and all of my code executes successfully.
    • [x] Completeness: I have explained everything fully, including all necessary references and citations.

iamarunbrahma avatar Jan 20 '25 08:01 iamarunbrahma