Skip to content

Chore/cleanup issue docs #218

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.

Sign up for GitHub

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

Merged
Demirrr merged 2 commits into from
May 28, 2026
Merged

Chore/cleanup issue docs #218

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b5ed6a1
chore: Remove redundant issue documentation files
Demirrr May 27, 2026
e1c18cb
docs: Add comprehensive LLM-friendly documentation in markdown_docs/
Demirrr May 27, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
220 changes: 0 additions & 220 deletions ISSUE_205_SOLUTION.md
View file
Open in desktop

This file was deleted.

22 changes: 21 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,27 @@ wget https://files.dice-research.org/projects/Ontolearn/KGs.zip -O ./KGs.zip &&
PYTHONPATH=. pytest
```

## 📋 Examples
## � Documentation

### LLM-Friendly Documentation

For comprehensive, LLM-optimized documentation, check out the [`markdown_docs/`](markdown_docs/) directory:

- **[Getting Started](markdown_docs/01_getting_started.md)** - Installation, setup, and quick start guide
- **[Core Concepts](markdown_docs/02_core_concepts.md)** - OWL fundamentals, ontologies, reasoners, and class expressions
- **[Ontology Management](markdown_docs/03_ontology_management.md)** - Creating, loading, saving, and modifying ontologies
- **[Reasoning](markdown_docs/05_reasoning.md)** - Complete guide to RDFLibReasoner, StructuralReasoner, and SyncReasoner
- **[Common Patterns](markdown_docs/08_common_patterns.md)** - Best practices, patterns, and anti-patterns
- **[API Reference](markdown_docs/09_api_reference.md)** - Complete API documentation

These docs are specifically formatted for LLM consumption and provide detailed examples, type information, and troubleshooting guidance.

### Official Documentation

- **[Online Documentation](https://dice-group.github.io/owlapy/usage/main.html)** - Complete API reference and tutorials
- **[DeepWiki Assistant](https://deepwiki.com/dice-group/owlapy)** - AI-powered documentation assistant

## �📋 Examples

### Exploring OWL Ontology

Expand Down
Loading
Loading