Skip to content

docs: Add discord link to Community page in docs #2157

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

Open
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

sanjeed5
Copy link
Contributor

@sanjeed5 sanjeed5 commented Aug 7, 2025

No description provided.

The mkdocstrings plugin was configured with 'paths: [src]' but the actual
source code is located at 'ragas/src' relative to the mkdocs.yml file.

This was causing build failures with errors like:
- 'ragas.cache could not be found'
- 'ragas.embeddings could not be found'

The fix updates the path to 'ragas/src' which allows mkdocstrings to
properly generate API documentation when running 'mkdocs serve' locally.

Resolves mkdocstrings module import errors during local documentation development.
…ion to core_concepts

- Reorder experimental tutorials in mkdocs.yml to follow logical progression:
  Prompt → RAG → Workflow → Agent (instead of Agent being first)
- Rename docs/experimental/explanation/ to core_concepts/ for consistency
- Update navigation links and section titles to match new structure
- Fix 'Next' button navigation to follow intended learning path

Fixes navigation issue where 'Next' from tutorials index went to Agent
instead of starting with Prompt tutorial.
Copy link
Contributor

@greptile-apps greptile-apps bot left a comment

Choose a reason for hiding this comment

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

Greptile Summary

This PR enhances the community documentation by adding a Discord section and making a minor punctuation improvement. The main change introduces a new "Discord community" section positioned prominently near the top of the community page, providing users with a direct link to join the Ragas Discord server at https://discord.com/invite/5djav8GGNZ. This addition serves to connect developers, facilitate idea sharing, and provide community support channels.

The change fits well within the existing community documentation structure, which already emphasizes collaboration and knowledge sharing through contributors, blog insights, and events. By placing the Discord section early in the document (after the overview but before contributors), it ensures high visibility for this real-time communication channel. The PR also includes a small punctuation enhancement by adding an exclamation mark to the Contributors section header, making it more welcoming and enthusiastic.

These changes align with the community page's stated purpose of fostering collaboration and providing resources for community engagement. The Discord integration represents a natural extension of the existing community infrastructure, offering immediate support and discussion opportunities that complement the existing blog posts, contributor profiles, and event listings.

Confidence score: 5/5

  • This PR is safe to merge with minimal risk as it only adds documentation content without affecting any code functionality
  • Score reflects simple, low-risk documentation changes that enhance community engagement without introducing technical complexity
  • No files require special attention as this is a straightforward documentation update

1 file reviewed, no comments

Edit Code Review Bot Settings | Greptile

@dosubot dosubot bot added the size:XS This PR changes 0-9 lines, ignoring generated files. label Aug 7, 2025
Copy link
Member

@jjmachan jjmachan left a comment

Choose a reason for hiding this comment

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

can we add

Image

to the page too?

@jjmachan
Copy link
Member

jjmachan commented Aug 7, 2025

also I think the mkdocs navbar title is missing a "❤️" in front of it - matching with the title

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
size:XS This PR changes 0-9 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants