Revise README.md to provide comprehensive documentation for the Digital Banking and Institutional System (DBIS), including an overview, document structure, key documents, usage guidelines, and version control information.
This commit is contained in:
109
README.md
109
README.md
@@ -1,32 +1,99 @@
|
||||
# dbis_docs
|
||||
# Digital Banking and Institutional System (DBIS)
|
||||
## Complete Institutional Documentation
|
||||
|
||||
## Environment Setup
|
||||
---
|
||||
|
||||
This repository uses a `.env` file for configuration, including GitHub authentication.
|
||||
## OVERVIEW
|
||||
|
||||
### Loading Environment Variables
|
||||
This repository contains the complete institutional documentation for the Digital Banking and Institutional System (DBIS). It includes all constitutional documents, statutory code, governance frameworks, technical specifications, and operational procedures.
|
||||
|
||||
To load environment variables from `.env`:
|
||||
---
|
||||
|
||||
```bash
|
||||
source load_env.sh
|
||||
```
|
||||
## DOCUMENT STRUCTURE
|
||||
|
||||
This will export `GITHUB_TOKEN` and other variables from `.env` to your current shell session.
|
||||
### 13 Major Categories
|
||||
|
||||
### Using GITHUB_TOKEN
|
||||
1. **01_constitutional/** - Constitutional and Charter Documents
|
||||
2. **02_statutory_code/** - Complete Statutory Code (Titles I-XX)
|
||||
3. **03_governance/** - Governance and Statutory Framework
|
||||
4. **04_legal_regulatory/** - Legal and Regulatory Instruments
|
||||
5. **05_financial_reserve/** - Financial and Reserve Systems
|
||||
6. **06_cyber_sovereignty/** - Cyber-Sovereignty and Security Protocols
|
||||
7. **07_member_integration/** - Member State Integration
|
||||
8. **08_operational/** - Operational Procedures
|
||||
9. **09_intelligence_security/** - Intelligence and Security Frameworks
|
||||
10. **10_diplomatic_treaty/** - Diplomatic and Treaty Instruments
|
||||
11. **11_technical_specs/** - Technical Specifications
|
||||
12. **12_compliance_audit/** - Compliance and Audit Systems
|
||||
13. **13_emergency_contingency/** - Emergency and Contingency Protocols
|
||||
|
||||
The `GITHUB_TOKEN` can be used for:
|
||||
### Special Directories
|
||||
|
||||
1. **GitHub API calls**: Export it and use in scripts or API requests
|
||||
```bash
|
||||
source load_env.sh
|
||||
curl -H "Authorization: token $GITHUB_TOKEN" https://api.github.com/user
|
||||
```
|
||||
- **onboarding_package/** - Member State Onboarding Package
|
||||
- **gru_reserve_system/** - GRU Reserve System Documentation
|
||||
- **csp_1113/** - Cyber-Sovereignty Protocol CSP-1113
|
||||
- **formatted_book/** - Institutional Book Structure
|
||||
- **visual_assets/** - Visual Identity Specifications
|
||||
|
||||
2. **Git HTTPS authentication** (if needed): Configure git to use the token:
|
||||
```bash
|
||||
git config credential.helper "$(pwd)/git-credential-helper.sh"
|
||||
```
|
||||
---
|
||||
|
||||
**Note**: This repository is currently configured to use SSH authentication (recommended). The token is available for other GitHub API operations if needed.
|
||||
## KEY DOCUMENTS
|
||||
|
||||
### Foundational Documents
|
||||
- **DBIS Constitutional Charter** - Supreme governing document
|
||||
- **Instrument of Establishment** - Formal creation instrument
|
||||
- **Articles of Governance** - Core operational framework
|
||||
|
||||
### Statutory Code
|
||||
- **20 Complete Titles** - Comprehensive statutory framework (300+ pages)
|
||||
|
||||
### Technical Documentation
|
||||
- **CSP-1113 Technical Specification** - Cyber-Sovereignty Protocol
|
||||
- **GRU Reserve System Whitepaper** - Complete reserve system documentation
|
||||
|
||||
### Integration Materials
|
||||
- **Member State Onboarding Package** - Complete integration suite
|
||||
- **Diplomatic Credentials Guide** - Protocol for diplomatic relations
|
||||
- **Sovereign Compliance Handbook** - Compliance requirements
|
||||
|
||||
---
|
||||
|
||||
## DOCUMENT COUNT
|
||||
|
||||
**Total Documents:** 70+ complete documents across all categories
|
||||
|
||||
---
|
||||
|
||||
## USAGE
|
||||
|
||||
### For Members
|
||||
- Review applicable documents in your category
|
||||
- Follow integration procedures for new members
|
||||
- Maintain compliance with all requirements
|
||||
|
||||
### For Developers
|
||||
- Technical specifications in `11_technical_specs/`
|
||||
- CSP-1113 documentation in `csp_1113/`
|
||||
- System architecture in technical documents
|
||||
|
||||
### For Legal/Compliance
|
||||
- Statutory Code in `02_statutory_code/`
|
||||
- Regulatory Framework in `04_legal_regulatory/`
|
||||
- Compliance documentation in `12_compliance_audit/`
|
||||
|
||||
---
|
||||
|
||||
## VERSION CONTROL
|
||||
|
||||
All documents are version-controlled. Check document headers for version information and effective dates.
|
||||
|
||||
---
|
||||
|
||||
## CONTACT
|
||||
|
||||
For questions or clarifications regarding these documents, contact the DBIS Executive Directorate.
|
||||
|
||||
---
|
||||
|
||||
**Last Updated:** [Date]
|
||||
**Version:** 1.0
|
||||
|
||||
Reference in New Issue
Block a user