Skip to content

Latest commit

 

History

History
291 lines (247 loc) · 6.24 KB

Rdm_standards.md

File metadata and controls

291 lines (247 loc) · 6.24 KB

READMEs Documentation Standards

Quick Links

📘 System Navigation:

LLM Processing Protocol

Navigation Rules

llm_protocol:
  context_management:
    max_depth: 3
    warmhole_links: true  # Direct knowledge jumps
    state_preservation: enabled
  
  document_processing:
    start_point: quick_links
    parse_order:
      - configuration
      - examples
      - implementation
    
  attention_optimization:
    priority_sections: ["config", "examples", "state"]
    context_switches: minimal
    reference_depth: 2

State Tracking

# State Management
- preserve: current_context
- reference: previous_outputs
- warmhole_enabled: true

Document Structure

Required Components

  1. File Header
// filepath: /path/to/file.md
# Document Title

## Quick Links
📘 Related Docs:
- [Essential cross-references]
  1. Section Organization
## Major Section
One-line overview

### Subsection
- Key points
- Examples
- References

Integration Points

Formatting Standards

Code Blocks

# Code Example
- language_tag: required
- filepath: required
- context: conditional

MDScript Syntax

# Function: function_name
- description: "Function description"
- input: param_name: type
- output: param_name: type
- template: template_name

Variable Declarations

# Variable: variable_name
- type: variable_type
- default: default_value

Template Definitions

# Template: template_name
- input_placeholder: "{{placeholder}}"
- transform: "Transformation description"
- output_format: "Output format description"

Conditional Logic

# Execute: Condition
- if: {{condition}}
  - function: function_name
- else:
  - function: alternative_function_name

Example: Function Definition

# Function: process_text
- description: "Analyzes a text input for word count."
- input: text: string
- output: word_count: integer
- template: analyze_template

Example: Variable Declaration

# Variable: current_user
- type: string
- default: "guest"

Example: Template Definition

# Template: analyze_template
- input_placeholder: "{{text}}"
- transform: "Split {{text}} into words, then count"
- output_format: "Word count: {{word_count}}"

Example: Conditional Logic

# Execute: Condition
- if: {{system_state}} == 'test'
  - function: run_tests
- else:
  - function: build_app

State-Aware Warmholes

# Warmhole: warmhole_name
- description: "Warmhole description"
- state_transfer: ["state_variable1", "state_variable2"]
- condition: "{{condition}}"

Example: State-Aware Warmhole

# Warmhole: data_processing
- description: "Processes data and transfers state"
- state_transfer: ["data_path", "dataset_format"]
- condition: "{{system_state}} == 'processing'"

LLM-Powered Warmhole Management

# Warmhole: warmhole_name
- description: "Warmhole description"
- state_transfer: ["state_variable1", "state_variable2"]
- condition: "{{condition}}"
- optimization: "LLM optimization description"
- semantic_link: "Semantic description of the warmhole link"
- auto_document: true

Example: LLM-Powered Warmhole

# Warmhole: data_processing
- description: "Processes data and transfers state"
- state_transfer: ["data_path", "dataset_format"]
- condition: "{{system_state}} == 'processing'"
- optimization: "Optimize data processing based on current system state"
- semantic_link: "Link to data analysis warmhole"
- auto_document: true

Code Block Enclosure

All function definitions, variable declarations, template definitions, and conditional logic must be enclosed in code blocks.

# Function: function_name
- description: "Function description"
- input: param_name: type
- output: param_name: type
- template: template_name
# Variable: variable_name
- type: variable_type
- default: default_value
# Template: template_name
- input_placeholder: "{{placeholder}}"
- transform: "Transformation description"
- output_format: "Output format description"
# Execute: Condition
- if: {{condition}}
  - function: function_name
- else:
  - function: alternative_function_name

Cross-References

# Reference Types
- direct: [Section](#section)
- contextual: [Doc](file.md#section)
- state: {{variable}}

LLM Navigation Guide

1. Context Assessment

context_rules:
  evaluate:
    - current_task
    - available_docs
    - state_requirements
  
  optimize:
    - token_usage
    - attention_flow
    - state_tracking

2. Document Processing

# Processing Steps
1. Check quick links
2. Assess task context
3. Navigate to relevant section
4. Execute specific task
5. Maintain state references

3. State Preservation

# State Guidelines
- track_changes: true
- preserve_context: true
- link_documents: enabled

Best Practices

Documentation Creation

  1. Follow Git integration
  2. Apply testing standards
  3. Use warmhole links for context jumps
  4. Maintain clear section hierarchy

LLM Interaction

  1. Start with quick links
  2. Use minimal context switches
  3. Follow reference chains
  4. Preserve state information

Maintenance

  1. Regular validation
  2. Context optimization
  3. Link verification
  4. State synchronization

Implementation Notes

For technical details:

Cross-References

📝 This document serves as the standard reference for READMEs system documentation.