<h1 align="center">
<a href="https://prompts.chat">
generic skill
Loading actions...
<a href="https://prompts.chat">
TypeScript and ESLint rules that MUST be followed when creating, modifying, or reviewing any file under apps/frontend/, including .ts, .tsx, .js, and .jsx files. Also apply when discussing frontend linting, type safety, or ESLint configuration.
risks
Follow these conventions when creating or editing documentation:
Docs live in docs/
• Use Markdown (.md) files.
• Images and other assets go in docs/_static/.
Section Folders mirror MkDocs navigation (see mkdocs.yml):
• 🚀 Get Started → docs/getstarted/
• 📚 Core Concepts → docs/concepts/
• 🧪 Experimental → docs/experimental/
• 🛠️ How-to Guides → docs/howtos/
• 📖 References → docs/references/
• Community → docs/community/
Place new pages in the appropriate folder and update mkdocs.yml nav: so the page appears in navigation.
Notebook-to-Markdown
• Convert notebooks to Markdown with docs/ipynb_to_md.py.
• Commit the generated .md; notebooks themselves should not live in docs/.
Local preview / build
• Run make build-docs to build HTML, make serve-docs to preview locally (defined in DEVELOPMENT.md).
Style & Assets
• Use relative links (../) within docs.
• Reference images via _static/… paths so they work in both dev and hosted docs.
• Custom templates/CSS live in docs/extra/ — avoid editing material theme defaults directly.
API References (mkdocstrings)
• Always use public API paths in [ClassName][ragas.module.ClassName] references.
• Check what's exported in __init__.py — if a class isn't in __all__, mkdocstrings can't link to it.
• Example: Use [BasePrompt][ragas.prompt.BasePrompt] not [BasePrompt][ragas.prompt.base.BasePrompt] or internal module paths.
Do not modify generated or third-party files in _static/, extra/overrides/, or extra/components/ without good reason.