Central hub for F1R3FLY.io's organizational documentation, templates, and governance. This repository serves as the single source of truth for organization-wide knowledge management and project standards.
# Clone the documentation repository
git clone https://github.com/F1R3FLY-io/.github.git
# Navigate to documentation
cd .github
# View documentation structure
tree docs/
# Edit with your preferred editor
code docs/# Create new documentation branch
git checkout -b docs/your-feature
# Make documentation changes
# Follow the documentation-first methodology
# Submit pull request for review
git add . && git commit -m "docs: add new feature documentation"
git push origin docs/your-featureThis repository follows F1R3FLY.io's documentation-first methodology, serving as the central knowledge base for the entire organization. All organizational changes, new projects, and processes begin with documentation.
- f1r3fly - Main transaction server (Scala/Rust)
- rholang-rs - Rholang interpreter (Rust)
- rholang-language-server - LSP-based Language Server for Rholang (Rust)
- graph-to-rholang-parser - Graph to RhoLang parser (Rust)
- embers - F1R3Sky wallets and agents (Rust)
- embers-frontend - Web interface (TypeScript)
- f1r3sky - F1R3FLY BlueSky fork (TypeScript)
- lightning-bug - Modern, extensible, browser-based code editor (Clojure)
- MeTTa - MeTTa 2.0 language (Scala)
- F1r3bu1ld3r - Visualization tool for Infrastructure as Code
Complete Repository Guide - View all projects with detailed descriptions
- Documentation Index - Complete documentation guide
- Repository Guide - Navigate all projects
- Project Template - Standard repository template
- FIP Process - Improvement proposals
- LLM Context - AI assistant context
- GitHub Organization - View all repositories
- Repository Guide: Complete overview of all F1R3FLY.io projects
- Project Template: Standard template for new repositories
- Organization Profile: Public GitHub organization profile
requirements:
user_stories: "Feature requirements from stakeholder perspective"
business_requirements: "Business logic and organizational constraints"
acceptance_criteria: "Definition of done for organizational features"
specifications:
technical: "API specifications, data schemas, and technical standards"
standards: "Coding standards and best practices"
processes: "Development workflows and procedures"
architecture:
decisions: "Architecture Decision Records (ADRs)"
diagrams: "System component diagrams and organizational structure"
patterns: "Established patterns and conventions"
templates: "Reusable document templates"
governance: "Organizational policies and procedures"- Contributing Guide: Complete workflow for documentation contributions
- Documentation Standards: Guidelines for creating and maintaining documentation
- GitHub Setup: Organization GitHub configuration
When using AI coding assistants across F1R3FLY.io projects, reference:
- Organization Context: CLAUDE.md in this repository
- Project Context: Individual project CLAUDE.md files
- Standards: Documentation from docs/specifications/standards/
- Templates: Resources from docs/templates/
- Architecture: Constraints from docs/architecture/
github:
docs:
requirements: "Organizational requirements and user stories"
specifications: "Technical standards and processes"
architecture: "Organization structure and design decisions"
api: "Integration documentation and protocols"
templates: "Document templates and examples"
governance: "Organizational policies and procedures"
profile:
README.md: "Public organization profile page"
github_config:
workflows: "Organization-wide CI/CD templates"
CLAUDE.md: "AI assistant context for organization"
README.md: "This file - repository overview"
LICENSE: "Repository license"documentation_first:
step_1: "Start with organizational requirements in docs/requirements/"
step_2: "Create/update standards and processes in docs/specifications/"
step_3: "Document architectural decisions in docs/architecture/decisions/"
organization_wide_llm_integration:
context_source: "Provide comprehensive context from CLAUDE.md"
project_context: "Reference project-specific CLAUDE.md files in individual repositories"
maintenance: "Update documentation alongside organizational changes"
documentation_standards:
methodology: "Follow documentation-first methodology for all changes"
commits: "Use conventional commits for documentation changes"
reviews: "Require pull request reviews for documentation updates"
consistency: "Maintain consistency across all F1R3FLY.io projects"
continuous_knowledge_management:
accuracy: "Keep organizational documentation updated and accurate"
templates: "Update relevant templates with organizational changes"
cross_references: "Maintain cross-references between projects and documentation"blockchain: "RNode platform with multi-consensus mechanisms"
languages: "Scala, Rust, TypeScript, Python, Clojure, Swift, Java"
distributed_systems: "High-throughput transaction processing"
smart_contracts: "Rholang concurrent programming language"language_servers: "Rholang LSP for IDE support"
build_systems: "Various per-language (sbt, Cargo, npm, Gradle)"
version_control: "Git with documentation-first branching"
documentation: "Markdown with GitHub integration"core_platform:
f1r3fly:
url: "https://github.com/F1R3FLY-io/f1r3fly"
description: "Main transaction server"
rholang_rs:
url: "https://github.com/F1R3FLY-io/rholang-rs"
description: "Rust Rholang implementation"
user_applications:
embers:
url: "https://github.com/F1R3FLY-io/embers"
description: "F1R3Sky wallets and agents"
f1r3sky:
url: "https://github.com/F1R3FLY-io/f1r3sky"
description: "Decentralized social platform"
developer_tools:
rholang_language_server:
url: "https://github.com/F1R3FLY-io/rholang-language-server"
description: "LSP for Rholang"
F1r3bu1ld3r:
url: "https://github.com/F1R3FLY-io/F1r3bu1ld3r"
description: "Infrastructure visualization"
research_innovation:
MeTTa:
url: "https://github.com/F1R3FLY-io/MeTTa"
description: "Meta-Type Talk language"
F1R3FLYFS:
url: "https://github.com/F1R3FLY-io/F1R3FLYFS"
description: "Distributed file system"public_portal:
url: "https://github.com/F1R3FLY-io/.github"
description: "Public documentation portal"
organization_guide:
url: "https://github.com/F1R3FLY-io/.github/blob/main/docs/Organization_of_Repositories.md"
description: "Complete project overview"
project_template:
url: "https://github.com/F1R3FLY-io/.github/blob/main/docs/Project_Template.md"
description: "Standard repository template"improvement_proposals:
url: "https://github.com/F1R3FLY-io/fflip"
description: "F1R3FLY improvement proposals"
security: "Organization-wide security policies and procedures"
standards: "Coding standards and best practices across projects"documentation_first: "All changes start with documentation"
follow_templates: "Use templates from docs/templates/"
review_process: "All documentation requires pull request review"
consistency: "Maintain organization-wide standards"- Contributing Guide: Complete workflow for documentation contributions
- Documentation Standards: Guidelines for creating and maintaining documentation
- Project Requirements: Check individual project repositories for specific requirements
- Project Template: Standard template for new repositories
step_1: "Document Requirements - Define purpose and acceptance criteria"
step_2: "Create Specifications - Technical details and implementation approach"
step_3: "Architecture Decisions - Document design choices and rationale"
step_4: "Implementation - Execute based on approved documentation"
step_5: "Validation - Ensure implementation matches documentation"
F1R3FLY.io is committed to advancing distributed computing and blockchain technology through:
principles:
- "Open source collaboration and transparency"
- "Documentation-first development methodology"
- "Innovation in concurrent programming languages"
- "High-performance transaction processing systems"organization_website: "https://f1r3fly.io"
documentation_portal: "https://github.com/F1R3FLY-io/.github"
repository_guide: "https://github.com/F1R3FLY-io/.github/blob/main/docs/Organization_of_Repositories.md"
improvement_proposals: "https://github.com/F1R3FLY-io/fflip"
contact: "[email protected]"F1R3FLY.io Organization Hub: This repository serves as the central documentation and governance hub for the F1R3FLY.io organization. All organizational knowledge, standards, and templates are maintained here to support our distributed development ecosystem.