UNPKG

credl-parser-evaluator

Version:

TypeScript-based CREDL Parser and Evaluator that processes CREDL files and outputs complete Intermediate Representations

github.com/bizarc/credl

bizarc/credl

112 lines (85 loc) • 5.07 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
# CREDL Documentation *Complete documentation for the CREDL (Commercial Real Estate Domain Language) parser and ecosystem* --- ## 📖 For Users **Getting Started** - [Language Reference](CREDL_REFERENCE.md) - Complete CREDL language specification and syntax guide - [Usage Examples](USAGE_EXAMPLES.md) - Common patterns and use cases - [Troubleshooting](TROUBLESHOOTING.md) - Common issues and solutions **Integration Guides** - [API Reference](API_REFERENCE.md) - Programmatic usage and integration - [CLI Reference](CLI_REFERENCE.md) - Command-line interface documentation - [CLI Examples](CLI_EXAMPLES.md) - Practical command-line usage examples **Practical Guides** - [Example Files Guide](EXAMPLE_FILES_GUIDE.md) - Walkthrough of provided examples - [Vacant Space Guide](VACANT_SPACE_GUIDE.md) - Best practices for modeling vacant spaces - [Workflow Examples](WORKFLOW_EXAMPLES.md) - End-to-end workflow examples --- ## 🔧 For Contributors & Internal Team **Internal Documentation** - [Internal Documentation](internal/README.md) - Implementation details and architecture - [Developer Onboarding](internal/DEVELOPER_ONBOARDING.md) - Getting started as a contributor - [Developer Workflow](internal/DEVELOPER_WORKFLOW.md) - Development processes and standards **Implementation Details** - [Behavioral Specification](internal/CREDL_BEHAVIORAL_SPECIFICATION.md) - Definitive implementation decisions - [Implementation Roadmap](internal/IMPLEMENTATION_ROADMAP.md) - Development planning and priorities - [Implementation Ambiguities](internal/IMPLEMENTATION_AMBIGUITIES.md) - Resolved design decisions - [CI/CD Integration](internal/CI_CD_INTEGRATION.md) - Build and deployment processes **Development Resources** - [Block Reference Template](internal/BLOCK_REFERENCE_TEMPLATE.md) - Documentation template for new blocks - [Legacy Specification](internal/CREDL_Specification_v0.2_COMPLETE.md) - Historical specification reference - [Metadata Block Reference](internal/metadata-block-reference.md) - Detailed metadata documentation --- ## 🎯 Quick Navigation | Audience | Primary Documents | Purpose | |----------|------------------|---------| | **End Users** | Language Reference, API Reference, CLI Reference | Using CREDL for financial modeling | | **Integrators** | API Reference, Usage Examples, Troubleshooting | Building applications with CREDL | | **Contributors** | Internal Documentation, Developer Workflow | Contributing to CREDL development | | **Internal Team** | Behavioral Specification, Implementation Roadmap | Core development and architecture | --- ## 📁 Repository Structure ``` docs/ ├── README.md # This navigation guide ├── CREDL_REFERENCE.md # Primary user documentation ├── API_REFERENCE.md # Programmatic interface ├── CLI_REFERENCE.md # Command-line interface ├── USAGE_EXAMPLES.md # Practical examples ├── TROUBLESHOOTING.md # User support ├── EXAMPLE_FILES_GUIDE.md # Example walkthrough ├── CLI_EXAMPLES.md # CLI usage examples ├── WORKFLOW_EXAMPLES.md # End-to-end workflows ├── VACANT_SPACE_GUIDE.md # Vacant space modeling ├── assets/ # Diagrams and images └── internal/ # Internal team documentation ├── README.md # Internal docs navigation ├── DEVELOPER_ONBOARDING.md # Contributor guide ├── DEVELOPER_WORKFLOW.md # Development processes ├── CREDL_BEHAVIORAL_SPECIFICATION.md # Implementation decisions ├── IMPLEMENTATION_ROADMAP.md # Development planning └── ... # Additional internal docs ``` --- ## 🚀 Getting Started ### For New Users 1. Start with the [Language Reference](CREDL_REFERENCE.md) for complete syntax documentation 2. Review [Usage Examples](USAGE_EXAMPLES.md) for common patterns 3. Try the [CLI Examples](CLI_EXAMPLES.md) for hands-on experience ### For Developers Integrating CREDL 1. Review the [API Reference](API_REFERENCE.md) for programmatic usage 2. Check [Usage Examples](USAGE_EXAMPLES.md) for integration patterns 3. Use [Troubleshooting](TROUBLESHOOTING.md) for common integration issues ### For Contributors 1. Start with [Developer Onboarding](internal/DEVELOPER_ONBOARDING.md) 2. Review [Developer Workflow](internal/DEVELOPER_WORKFLOW.md) for processes 3. Consult [Internal Documentation](internal/README.md) for architecture details --- ## 📝 Documentation Standards - **User documentation** follows task-oriented structure - **API documentation** includes examples and error scenarios - **Internal documentation** covers architecture and implementation decisions - **All examples** are tested and maintained with the codebase - **Troubleshooting guides** provide step-by-step solutions --- *For questions about CREDL documentation, please refer to the appropriate audience section above or consult the internal team documentation.*