Plings Documentation
Created: Tue 29 Jul 2025 07:14:58 CEST
Updated: Wed 06 May 2026 17:14:18 CEST - Phase 1 naming migration: introduced Plings-Web/Plings-API/Plings-Gateway conventions; added native iOS/Android in architecture references; clarified scan transport-agnosticism (QR/NFC/RFID)
Updated: Fri 12 Jun 2026 17:53:24 CEST - Structure overview and placement table now include previously undocumented directories: /security/, /deployment/, /workflows/, /specs/, /troubleshooting/
Updated: Fri 12 Jun 2026 17:53:24 CEST - Consolidated admin docs: /frontend/admin/ (older Plings-Docs drafts) merged into top-level /admin/; structure overview and placement table updated accordingly
Document Version: 1.4 - Structure synced with actual docs/ directories; admin docs consolidated
Security Classification: Internal Technical Documentation
Target Audience: Developers, AI Agents, Technical Writers
Author: Paul WisΓ©n
Quick Navigation for AI Agents
This README serves as the primary navigation point for AI agents and developers working with Plings documentation. It provides the complete structure overview and placement guidelines.
Live Documentation Site: https://docs.plings.io
Naming migration in progress: The Plings system uses these conceptual repository names: Plings-API (disk:
Plings-API/), Plings-Gateway (disk:Plings-Gateway/), Plings-Web (disk:Plings-Web/), plus planned Plings-iOS and Plings-Android. Use the conceptual names in new documentation; reserve disk paths for actual file references. See the workspaceCLAUDE.mdfor full context.
Directory Structure Overview
ποΈ Core Architecture
/architecture/
βββ README.md # Architecture overview and principles
βββ system-overview.md # HIGH-PRIORITY: Multi-service ecosystem, Gateway layer
βββ database_architecture.md # Dual database design (PostgreSQL + Neo4j)
βββ technology-stack-decisions.md # Technology choices and rationale
βββ solana-payment-architecture.md # Blockchain payment integration
βββ api-security-guidelines.md # Security best practices
π§ Core Systems Documentation
/core-systems/
βββ README.md # Core systems overview
βββ s-plings-io/ # Gateway service documentation (transport-agnostic: QR/NFC/RFID)
β βββ README.md # Gateway overview (4 functions)
β βββ url-structure.md # URL parameters and routing
β βββ verification-strategy.md # Cached public key verification
β βββ routing-logic.md # Intelligent routing rules
βββ plings_identifier.md # HD wallet identifier system
βββ spatial-relationships.md # Object location tracking
βββ ownership-handling.md # Ownership and transfer logic
βββ class-system.md # Object classification system
π API Documentation
/api/
βββ README.md # API overview and integration guide
βββ api-endpoints.md # GraphQL schema and endpoints
βββ authentication.md # Authentication flows
βββ data-models.md # Core data structures
βββ integration-examples.md # Code examples and patterns
πΎ Database Documentation
/database/
βββ README.md # Database overview (β οΈ READ SCHEMA-VERIFICATION.md FIRST!)
βββ SCHEMA-VERIFICATION.md # π¨ CRITICAL: Verified production schema
βββ neo4j-core-schema.md # Graph database schema
βββ supabase-core-schema.md # PostgreSQL schema (wallet-first)
βββ migration-strategy.md # Database migration procedures
βββ predicate-catalogue.md # Relationship types catalog
π Use Cases & Requirements
/use-cases/
βββ overview.md # Use case index
βββ workflow-create-object.md # Object creation workflows
βββ workflow-scan-to-pay.md # Commerce scanning flows
βββ workflow-lost-and-found.md # Lost object recovery
βββ requirements-analysis.md # Business requirements
β οΈ IMPORTANT: Always check use cases before implementing features!
π¨ Frontend Documentation
/frontend/
βββ README.md # Frontend architecture overview
βββ component-architecture.md # React component structure and patterns
βββ state-management.md # State management patterns
βββ routing.md # Frontend routing system
Admin-console docs live at the top level in
/admin/(see below), not under/frontend/.
π‘οΈ Admin & System Management
/admin/
βββ README.md # Admin docs index + Admin Pages β Components map
βββ admin-dashboard.md # Cross-org business operations (/admin)
βββ developer-console.md # Technical debugging tools (/dev)
βββ super-admin-console.md # System-wide administration (/super)
βββ security-operations.md # Security management
βββ permission-model.md # Core permission architecture
βββ permission-model-detailed.md # Detailed permission implementation
βββ audit-log-system.md # Activity tracking and compliance
βββ class-management-console.md # Object class / type management
π§ Development Guides
/development/
βββ README.md # Development setup overview
βββ getting-started.md # Quick start guide
βββ api-integration.md # Backend integration patterns
βββ testing-strategy.md # Testing approaches
βββ deployment.md # Deployment procedures
π¨ Brand & Design
/brand/
βββ design-system.md # Design system guidelines
βββ implementation-guide.md # Implementation patterns
βββ requirements.md # Brand requirements
βββ fonts/Poppins/ # Font assets
βββ [Poppins font files]
π Security
/security/
βββ README.md # Security documentation overview
βββ api-key-management.md # API key handling and rotation
βββ private-key-use-cases.md # HD wallet private-key usage and trust
π Deployment
/deployment/
βββ README.md # Deployment documentation overview
βββ ci-cd.md # CI/CD pipeline (GitHub Actions / Vercel)
βββ deployment-procedures.md # Step-by-step deployment procedures
βββ environment-config.md # Environment variables and configuration
βββ monitoring-logging.md # Monitoring and logging setup
π Workflows
/workflows/
βββ README.md # End-to-end operational workflows
βββ batch-create-objects.md # Bulk object creation
βββ identifier-scan-flow.md # Scan β resolve β route flow
βββ process-unfinished-objects.md # Handling incomplete objects
βββ transfer-ownership.md # Ownership transfer workflow
π Specs
/specs/
βββ YYYY-MM-DD-<feature>-design.md # Dated design specs (e.g. password-management-design)
π οΈ Troubleshooting
/troubleshooting/
βββ README.md # Troubleshooting index
βββ backend-import-errors.md # Python import / module resolution issues
βββ backend-troubleshooting.md # General backend issues
βββ database-troubleshooting.md # PostgreSQL / Neo4j issues
βββ drag-drop-troubleshooting.md # Frontend drag-and-drop issues
βββ spatial-predicates-migration.md # Spatial predicate migration issues
π€ Agent Workflow Guidelines
Documentation Placement Rules
| Content Type | Primary Location | Secondary Location | Notes |
|---|---|---|---|
| New Features | /use-cases/ first |
Implementation in relevant system dir | Always document requirements first |
| System Architecture | /architecture/ |
Cross-reference in affected systems | Include impact analysis |
| API Changes | /api/ |
Update affected core systems | Maintain backwards compatibility docs |
| Database Changes | /database/ |
Update affected systems | Always update SCHEMA-VERIFICATION.md |
| Frontend Components | /frontend/ |
Include usage examples | Document props and state management |
| s.plings.io Gateway | /core-systems/s-plings-io/ |
Reference in architecture | Universal scan routing (QR/NFC/RFID) |
| Business Logic | /core-systems/ |
Cross-reference in API docs | Core system functionality |
| Admin / System Management | /admin/ |
Link from frontend docs | Admin/dev/super consoles, permissions, audit |
| Security | /security/ |
Reference in architecture | Key management, auth, trust boundaries |
| Deployment / CI-CD | /deployment/ |
Reference in development guides | Vercel deploy, env config, monitoring |
| Operational Workflows | /workflows/ |
Cross-reference in use-cases | End-to-end multi-step processes |
| Design Specs | /specs/ |
Link from use-cases / architecture | Dated design docs (YYYY-MM-DD-<feature>-design.md) |
| Troubleshooting | /troubleshooting/ |
Link from affected system docs | Known issues and fixes |
π Agent Development Workflow
- Start Here: Read this README.md for structure understanding
- Check Use Cases: Review
/use-cases/before implementing features - Verify Database Schema: Always check
/database/SCHEMA-VERIFICATION.mdfirst - Update Documentation: Alongside code changes, not after
- Jekyll Compatibility: Escape
withtags - Mermaid Diagrams: Use
<div class="mermaid">not markdown code fences - Cross-References: Link related documentation sections
- Timestamps: Add proper timestamps following CLAUDE.md format
π― Priority Documentation Areas
- HIGHEST:
/architecture/system-overview.md- System architecture understanding - HIGH:
/core-systems/s-plings-io/- Gateway service (universal scan entry point: QR / NFC / RFID) - HIGH:
/use-cases/- Requirements and business logic - MEDIUM:
/api/- Integration specifications - MEDIUM:
/database/SCHEMA-VERIFICATION.md- Current database state
π Finding Information Quickly
Common Agent Questions & Answers
| Question | Location | File |
|---|---|---|
| How do scans (QR / NFC / RFID) work? | /core-systems/s-plings-io/ |
README.md + routing-logic.md |
| Whatβs the system architecture? | /architecture/ |
system-overview.md |
| How do I integrate the API? | /api/ |
README.md + integration-examples.md |
| Whatβs the database schema? | /database/ |
SCHEMA-VERIFICATION.md (READ THIS FIRST!) |
| How do object relationships work? | /core-systems/ |
spatial-relationships.md |
| What are the use cases? | /use-cases/ |
overview.md |
| How does authentication work? | /api/ |
authentication.md |
| Whatβs the frontend architecture? | /frontend/ |
README.md |
π¨ Critical Files for Agents
/database/SCHEMA-VERIFICATION.md- Always read before database queries/architecture/system-overview.md- Understand the multi-service ecosystem/core-systems/s-plings-io/README.md- Universal scan entry point (QR / NFC / RFID)/use-cases/overview.md- Business requirements and user storiesCLAUDE.md- Development guidelines and agent usage instructions
π Documentation Standards
Required Elements
- Timestamps: Follow CLAUDE.md format with created/updated dates
- Jekyll Front Matter: Include layout, title, nav_order for navigation
- Target Audience: Specify who the documentation serves
- Cross-References: Link to related documents
- Examples: Include code examples and use cases
Jekyll Compatibility
- Liquid Syntax: Escape
{{ }}with{% raw %}{{ }} - Mermaid Diagrams: Use
<div class="mermaid">wrapper - Navigation: Files in
_config.ymlheader_pages appear in site menu
π Maintenance Notes
- Single Source of Truth: This README.md is the canonical structure reference
- Update Workflow: When structure changes, update this file first
- Agent Training: CLAUDE.md points agents here for detailed structure
- Live Site: Changes deploy automatically via GitHub Actions to docs.plings.io
This documentation structure reflects the Plings Universal Object Graph Systemβs sophisticated multi-service architecture with the s.plings.io Gateway layer as the intelligent routing hub for all physical object interactions.