Skip to content

fix(readme): correct SubQuestionQueryEngine link and fix formatting#247

Open
abdelhadi703 wants to merge 1 commit intomistralai:mainfrom
abdelhadi703:fix/readme-additional-link-fixes
Open

fix(readme): correct SubQuestionQueryEngine link and fix formatting#247
abdelhadi703 wants to merge 1 commit intomistralai:mainfrom
abdelhadi703:fix/readme-additional-link-fixes

Conversation

@abdelhadi703
Copy link
Copy Markdown

Cookbook Pull Request

Description

Fixes two additional README issues related to #244 (complementary to #245):

  1. SubQuestionQueryEngine.ipynb wrong link target: The link text says SubQuestionQueryEngine.ipynb but pointed to third_party/LlamaIndex/RouterQueryEngine.ipynb. Fixed to point to the correct file third_party/LlamaIndex/SubQuestionQueryEngine.ipynb (which exists).

  2. prompt_optimization.ipynb formatting: Double closing parenthesis )) broke the markdown link syntax. Also added missing trailing pipe | to complete the table row.

Type of Change

  • New Cookbook
  • Cookbook Update
  • README.md Update

  • Other

Cookbook Checklist:

  • My code is easy to read and well structured.
  • I have performed a self-review of my own code.
  • My changes generate no new warnings or errors.

  • My changes do not concern the cookbooks.

README.md Checklist

  • I've added my cookbook to the table.

  • My changes do not concern the README file.

Additional Context

These fixes complement PR #245 which addresses the four dead links (404) reported in issue #244. The two issues fixed here were not covered by that PR.

…tting

- SubQuestionQueryEngine.ipynb was incorrectly linking to RouterQueryEngine.ipynb
  instead of SubQuestionQueryEngine.ipynb
- prompt_optimization.ipynb had a double closing parenthesis )) breaking the
  markdown link, and missing table formatting (trailing pipe)

Related to mistralai#244
@abdelhadi703
Copy link
Copy Markdown
Author

Hi @mistralai/team,

Gentle ping on this PR. It's been almost a month without feedback.

This fix corrects a broken link and formatting issue in the README. Happy to address any review comments.

Thanks!

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.

1 participant