Skip to content
Readit logo Readit

Anatomy of a Readit

A Readit is more than just a single file. It’s a container for a collection of contextual components:

  • 🧠 System Instructions: The main Markdown file that sets the rules, personality, and primary instructions for the AI agent.

  • 📁 Additional Markdown Files: Reference documents, FAQs, data sheets, or any supplementary material the agent might need.

  • 💬 Saved Prompts/Notes: Reusable prompts or notes that can be referenced or embedded.

  • 🔗 Dynamic Sources & Links: Links to external commands or API endpoints that the agent can be instructed to use.

  • Commands: like search or push information endpoint

Creating Readits

Section titled “Creating Readits”

Writing Effective System Instructions:

# AI Assistant Context


## Role
You are a senior code reviewer with expertise in Python and best practices.


## Guidelines
- Focus on security, performance, and maintainability
- Suggest specific improvements with code examples
- Be constructive and educational in your feedback


## Code Standards
- Follow PEP 8 style guidelines
- Use type hints for function parameters
- Include docstrings for all public functions

File Management

Section titled “File Management”

Organizing Multiple Files:

my-context/          # Your readit
├── main.md          # Main system instructions
├── guidelines.md    # Detailed guidelines
├── examples.md      # Code examples
├── faq.md           # Common questions
└── ...

Linking internal Files:

For detailed examples, see [examples.md](./examples.md)

Linking other readit Files:

For dependencies, see [libraries](my-docs/libraries.md)

External Resource Links:

## Current Standards
- [Company Style Guide](https://company.com/style)
- [Security Checklist](https://security.company.com/checklist)

The Root File

Section titled “The Root File”

You can designate one file as the “main” or “root” file. This is the file that will be served when someone accesses the Readit’s base URL (e.g., .../<readit-slug>) without specifying a filename.

Accessing Specific Files

Section titled “Accessing Specific Files”

Append the filename to any Readit URL to get the raw Markdown content of that specific file.

https://readit.md/<token>/<readit-slug>/<filename>.md