Integration Examples

Popular AI Tools

ChatGPT / Gemini / Claude / Grok / DeepSeek / Qwen / Perplexity … :

Follow the guidelines here: https://readit.md/token.../guidelines

[Your actual prompt]

Custom Agents:

import requests

def get_context(readit_url):
    response = requests.get(readit_url)
    return response.text

context = get_context('https://readit.md/token.../my-context')
prompt = f"{context}\n\n{user_input}"

Development Workflows

CI/CD Integration:

# GitHub Actions example
- name: AI Code Review
  run: |
    curl https://readit.md/${{ secrets.READIT_TOKEN }}/code-review > context.md
    ai-reviewer --context=context.md --files=${{ github.event.pull_request.changed_files }}

Code Review Contexts: Create readits for different types of reviews:

• security-review - Security-focused guidelines
• performance-review - Performance optimization focus
• style-review - Code style and formatting

Advanced Workflows

Readit can be integrated into more sophisticated development pipelines to enrich your AI workflows.

Contextual Code Review with Search

You can combine Readit search with your CI/CD pipeline to provide commit-specific context for AI reviewers:

https://readit.md/${{ secrets.READIT_TOKEN }}/code-review?q=commit-summary

This query injects contextual resources such as related features, bug-fixing notes, or documentation snippets directly into the review context.

As a result, the AI can better understand the intent of the commit and maximize the quality of its feedback.

Post-Pipeline Documentation Updates

After a pipeline completes successfully, you can also use the Readit Post API to automatically append information to your documentation.

This enables you to:

• Track each commit or merge request in a structured Readit.
• Keep your codebase documentation continuously updated.
• Provide a historical context log for future reviews and audits.

Example Flow:

1. Run AI code review with commit-specific context.
2. On successful pipeline completion, push a summary to the corresponding Readit.
3. Over time, build a commit-aware documentation hub directly inside Readit.