Skip to content

Commit 8e728fe

Browse files
committed
docs: update README with correct URLs and examples
- Fix GitHub URLs from yourusername to Prismer-AI - Update example path from PISA5 to agent_example - Replace non-existent documentation links with actual files - Fix typos: 'Enginnering' -> 'Engineering', 'deylopment' -> 'deployment' - Update development commands to use ruff format instead of black - Improve example section with more detailed information - Add realistic documentation roadmap
1 parent cb1feee commit 8e728fe

1 file changed

Lines changed: 46 additions & 32 deletions

File tree

README.md

Lines changed: 46 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@
3434
- 📊 **Observable**: Real-time execution tracking with beautiful CLI output powered by [Rich](https://github.com/Textualize/rich)
3535
- 🔄 **Event-Driven**: Production-ready deployment with [Temporal](https://temporal.io/) integration
3636
- 🎨 **Developer-Friendly**: Intuitive CLI, comprehensive logging, and extensive documentation
37-
- **Context Enginnering** 1st version Pyramid Context Engineering solution
37+
- **Context Engineering**: 1st version 'Pyramid Context Engineering' solution
3838

3939
---
4040

@@ -44,7 +44,7 @@
4444

4545
```bash
4646
# Clone the repository
47-
git clone https://github.com/yourusername/pisa.git
47+
git clone https://github.com/Prismer-AI/pisa.git
4848
cd pisa
4949

5050
# Install dependencies (using uv for faster installation)
@@ -240,44 +240,58 @@ Real-time execution visualization powered by [Rich](https://github.com/Textualiz
240240

241241
| Document | Description |
242242
|----------|-------------|
243-
| [Quick Start Guide](docs/QUICK_START_v4.md) | Step-by-step tutorial for beginners |
244-
| [Architecture Overview](docs/IMPLEMENTATION_ROADMAP.md) | System design and architecture |
245-
| [Agent Definition Reference](docs/agent_template.md) | Complete agent.md specification |
246-
| [Capability Development](docs/capability_guide.md) | How to create custom capabilities |
247-
| [Loop Templates](docs/loop_templates.md) | Available agent loop patterns |
248-
| [API Reference](docs/api/) | Full API documentation |
243+
| [README](README.md) | This file - Quick start and overview |
244+
| [Contributing Guide](CONTRIBUTING.md) | How to contribute to PISA |
245+
| [CHANGELOG](CHANGELOG.rst) | Version history and release notes |
246+
| [Example Agent](example/agent_example/.prismer/README.md) | Full example with math & data processing |
247+
| [Agent Template](src/pisa/core/definition/templates/agent_template.md) | Agent definition reference |
248+
| [Capability README](src/pisa/capability/README.md) | Capability system documentation |
249+
250+
**📖 Full documentation coming soon!** We're working on comprehensive guides for:
251+
- Quick Start Tutorial
252+
- Architecture Deep Dive
253+
- Capability Development Guide
254+
- Loop Template Creation
255+
- API Reference
249256

250257
---
251258

252259
## 🎨 Examples
253260

254-
### Example 1: Math & Data Processing Agent
261+
### Example: Math & Data Processing Agent
255262

256-
A sophisticated agent that performs matrix operations, calculates softmax, and generates structured tables:
263+
A sophisticated agent that performs matrix operations, calculates softmax, and generates structured tables.
264+
265+
**Location**: [`example/agent_example/`](example/agent_example/)
266+
267+
**Run the example:**
257268

258269
```bash
259-
cd example/PISA5
270+
cd example/agent_example
260271
pisa run .prismer/agent.md -i "Calculate [[1,2],[3,4]] × [[5,6],[7,8]], compute softmax, and show results as a table"
261272
```
262273

263-
**Capabilities Used:**
264-
- `matrix_operations` (Function): Matrix math operations
265-
- `compute_softmax` (MCP): Softmax calculations
266-
- `text_to_table` (Subagent): Generate markdown tables
274+
**Features demonstrated:**
275+
- ✅ Matrix operations (Function capability)
276+
- ✅ Softmax calculations (MCP capability)
277+
- ✅ Text-to-table conversion (Subagent capability)
278+
- ✅ Plan-Execute loop with OODA
279+
- ✅ Context management and persistence
280+
- ✅ Rich CLI output
267281

268-
### Example 2: Research Assistant *(coming soon)*
282+
**Example capabilities:**
283+
- `matrix_operations` - Matrix math (add, multiply, transpose, etc.)
284+
- `compute_softmax` - Temperature-scaled softmax
285+
- `softmax_with_attention` - Attention weights calculation
286+
- `text_to_table` - Convert text to structured tables
269287

270-
```bash
271-
cd example/research-assistant
272-
pisa run .prismer/agent.md -i "Find recent papers on transformer architectures and summarize key findings"
273-
```
288+
### More Examples Coming Soon!
274289

275-
### Example 3: Code Review Agent *(coming soon)*
276-
277-
```bash
278-
cd example/code-reviewer
279-
pisa run .prismer/agent.md --file src/my_code.py
280-
```
290+
We're working on additional examples:
291+
- 🔜 **Research Assistant** - Web search and paper summarization
292+
- 🔜 **Code Review Agent** - Automated code analysis and suggestions
293+
- 🔜 **Data Analysis Agent** - CSV/JSON processing and visualization
294+
- 🔜 **Customer Support Bot** - Multi-turn conversation with knowledge base
281295

282296
---
283297

@@ -334,7 +348,7 @@ PISA follows a clean, modular architecture:
334348

335349
- 🔲 SOTA loop templates
336350
- 🔲 Context compression with LOD (Level of Detail)
337-
- 🔲 Temporal workflow integration for production ready deylopment
351+
- 🔲 Temporal workflow integration for production ready deployment
338352
- 🔲 Multi-agent collaboration
339353
- 🔲 Streaming response support
340354

@@ -355,7 +369,7 @@ We welcome contributions! Please see our [Contributing Guide](CONTRIBUTING.md) f
355369

356370
```bash
357371
# Clone and install in development mode
358-
git clone https://github.com/yourusername/pisa.git
372+
git clone https://github.com/Prismer-AI/pisa.git
359373
cd pisa
360374
uv pip install -e ".[dev]"
361375

@@ -365,8 +379,8 @@ uv run pytest tests/ -v
365379
# Run linter
366380
uv run ruff check src/
367381

368-
# Format code
369-
uv run black src/
382+
# Format code (using ruff format)
383+
uv run ruff format src/
370384
```
371385

372386
### Areas We Need Help
@@ -396,8 +410,8 @@ PISA is released under the [MIT License](LICENSE.txt).
396410

397411
## 📬 Contact & Support
398412

399-
- **Issues**: [GitHub Issues](https://github.com/yourusername/pisa/issues)
400-
- **Discussions**: [GitHub Discussions](https://github.com/yourusername/pisa/discussions)
413+
- **Issues**: [GitHub Issues](https://github.com/Prismer-AI/pisa/issues)
414+
- **Discussions**: [GitHub Discussions](https://github.com/Prismer-AI/pisa/discussions)
401415
- **Email**: support@prismer.ai
402416
- **Twitter**: [@PrismerAI](https://twitter.com/PrismerAI)
403417

0 commit comments

Comments
 (0)