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

Implement Related Blog Posts Feature #6

Open
brylie opened this issue Jul 29, 2024 · 0 comments
Open

Implement Related Blog Posts Feature #6

brylie opened this issue Jul 29, 2024 · 0 comments

Comments

@brylie
Copy link
Owner

brylie commented Jul 29, 2024

Enhance the blog post detail page by displaying related blog posts based on content similarity. This feature will use the Wagtail Vector Search plugin to find and present semantically similar content, encouraging readers to explore our blog more and increase user engagement.

Tasks

  1. Modify the blog post detail view to fetch related posts using vector search.
  2. Design and implement a "Related Posts" section in the blog post template.
  3. Optimize the query to balance relevance and performance.
  4. Implement caching if necessary to improve load times.
  5. Ensure the feature gracefully handles cases where no related posts are found.
  6. Add appropriate unit and integration tests for the new functionality.

Implementation Details

Refer to the Wagtail Vector Search documentation for specific implementation guidance:
https://wagtail-vector-index.readthedocs.io/en/latest/using-indexes/#getting-similar-content

Key points to consider:

  • Use the find_similar method to find related content.
  • Adjust the similarity threshold and number of results as needed.
  • Consider the performance implications and optimize accordingly.

Acceptance Criteria

  • Each blog post detail page displays a section with 1-5 related blog posts.
  • Related posts are determined using vector similarity, not just by category or tag.
  • The related posts section includes the title and a brief excerpt or summary of each related post.
  • Clicking on a related post takes the user to that post's detail page.
  • The feature does not significantly impact page load times.
  • The UI of the related posts section is consistent with the overall blog design.

Additional Notes

  • Consider implementing a fallback method (e.g., most recent posts) if no related posts are found.
  • Discuss whether to exclude the current post from future "related posts" sections to avoid circular references.
  • Think about how to present the relatedness to users (e.g., "Similar Posts", "You might also like", etc.).
  • Consider adding an option in the admin interface to manually curate related posts, overriding the automatic suggestions when desired.

Resources

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

No branches or pull requests

1 participant