BFO-based semantic framework incorporating Common Core Ontologies, extended through domain-specific and application-level ontologies for AI-powered knowledge management.
π Live Documentation | π§ ABI Repository | π¬ Community
This repository contains the official documentation for the Naas Ontology, a comprehensive semantic framework that incorporates Basic Formal Ontology (BFO) and Common Core Ontologies (CCO), extending them through domain-specific and application-level ontologies for AI-powered knowledge management.
The Naas Ontology provides the foundational semantic structure for the Agentic Brain Infrastructure (ABI), enabling process-centric AI routing and intelligent knowledge graph management.
The Naas Ontology follows a principled 4-level hierarchy:
- Top-Level - BFO Slim (essential foundational classes for AI systems)
- Mid-Level - CCO extensions (Agent, Event, Quality, Organization ontologies)
- Domain-Level - ABI concepts (AI Agent, Workflow, Trigger, Capability ontologies)
- Application-Level - Third-party integrations (LinkedIn, Microsoft Office, Google Workspace)
- BFO-Grounded - All concepts properly grounded in formal ontological principles
- Process-Centric - AI routing based on BFO's 7 Buckets framework
- Enhanced Code Highlighting - Proper Turtle and SPARQL syntax highlighting
- Comprehensive Coverage - 74+ documented concepts across all ontological levels
- Application Integrations - Third-party system ontologies (Office, Google Workspace, LinkedIn)
- Design Patterns - Reusable CCO modeling patterns for consistent development
- Production Ready - Used in the Agentic Brain Infrastructure (ABI)
- Node.js >= 20.0
- npm or yarn
- Docker (optional, for containerized development across multiple codebases)
-
Clone the repository
git clone https://github.com/jupyter-naas/ontology.git cd ontology
-
Install dependencies
cd site npm install
-
Start development server (from the
site/
directory)cd site npm start
-
Open your browser
The site will automatically reload when you make changes to the documentation files.
The development server from the installation steps above provides hot reloading - changes are reflected live without restarting the server.
cd site
npm run build
This command generates static content into the build
directory and can be served using any static contents hosting service.
cd site
npm run serve
Serves the production build locally for testing purposes.
This ontology documentation site is built with Docusaurus and focuses on explaining the complete Naas Ontology framework.
ontology/
βββ site/ # Docusaurus application
β βββ docs/ # Documentation content
β β βββ ontology-essentials/ # Complete ontology framework
β β β βββ introduction.md # Overview and architecture
β β β βββ top-level.md # BFO Slim foundation
β β β βββ mid-level.md # CCO extensions
β β β βββ domain-level.md # ABI domain concepts
β β β βββ application-level.md # Application integrations
β β β βββ process-routing.md # Process-centric AI routing
β β βββ bfo/ # BFO Slim documentation
β β βββ cco/ # CCO documentation
β β βββ abi/ # ABI domain documentation
β β βββ applications/ # Third-party integrations
β β βββ design-patterns/ # CCO modeling patterns
β β βββ guides/ # Modeling conventions
β β βββ reference/ # Prefixes and glossary
β βββ src/ # Custom React components
β βββ static/ # Static assets
βββ resources/ # ABI repository analysis
βββ scripts/ # Build and deployment scripts
βββ README.md # This file
site/docs/ontology-essentials/
- Complete ontology framework documentationsite/docs/bfo/
- BFO Slim classes and relationssite/docs/cco/
- CCO foundational conceptssite/docs/abi/
- ABI domain-specific conceptssite/docs/applications/
- Third-party system integrationssite/docs/design-patterns/
- Reusable CCO modeling patternssite/src/
- Custom React components and pagessite/static/
- Images, assets, and downloadable filessite/docusaurus.config.js
- Docusaurus configuration
Command | Description |
---|---|
npm start |
Start development server on port 3004 |
npm run build |
Build for production |
npm run serve |
Serve production build locally |
npm run clear |
Clear Docusaurus cache |
npm run swizzle |
Customize Docusaurus components |
npm run deploy |
Deploy to GitHub Pages |
The documentation is organized into comprehensive sections covering all ontological levels:
- Ontology Essentials - Complete architectural overview and principles
- BFO - Basic Formal Ontology Slim (essential foundational classes)
- CCO - Common Core Ontologies (Agent, Event, Quality, Organization)
- ABI - Agentic Brain Infrastructure domain concepts
- Applications - Third-party system integrations (Office, Google, LinkedIn)
- Design Patterns - Reusable CCO modeling patterns
- Guides - Modeling conventions and best practices
- Reference - Prefixes, glossary, and technical specifications
- Enhanced Code Highlighting - Proper Turtle and SPARQL syntax highlighting
- Mermaid Diagrams - Visual representations of ontological structures
- Interactive Examples - Real Turtle/RDF code with line highlighting
- Cross-References - Comprehensive linking between concepts
- Search Integration - Algolia-powered semantic search
We welcome contributions to improve the documentation!
- Fork the repository
- Create a feature branch
git checkout -b feature/improve-docs
- Make your changes
- Test locally
cd site npm start
- Submit a pull request
- Use clear, concise language with ontological precision
- Include Turtle code examples for all ontological concepts
- Follow BFO and CCO principles in all examples
- Use standardized Mermaid diagrams with proper styling
- Ground all concepts in formal ontological categories
- Test all links and references
- Use PascalCase for all markdown file names to match ontology conventions
- Ontology Essentials: Place framework docs in
docs/ontology-essentials/
- BFO Documentation: Place in
docs/bfo/
with proper hierarchy - CCO Documentation: Place in
docs/cco/
following CCO structure - ABI Documentation: Place in
docs/abi/
for domain concepts - Applications: Place in
docs/applications/
for third-party integrations - Follow the 4-level ontological hierarchy (Top β Mid β Domain β Application)
- Include proper BFO grounding in all new concepts
- Update navigation in
sidebars.js
when adding new sections
- Ontology Documentation: ontology.naas.ai
- Platform Documentation: docs.naas.ai
- ABI Repository: github.com/jupyter-naas/abi
- Community Slack: Join Here
- GitHub Issues: Report bugs or request features
Built with β€οΈ using Docusaurus