docs: Rebuild documentation as enterprise-grade TLAS platform
- Migrate from custom HTTP server to VitePress framework - Rename project to Tokenized License Approval System (TLAS) - Add comprehensive documentation for all stakeholders: - Business: Executive summary, value proposition, governance - Operations: Infrastructure, installation, monitoring, backup - Departments: User guide, workflows, verification, issuance - Developers: API reference, authentication, webhooks, SDKs - Compliance: OWASP, DPDP Act, IT Act, audit framework - Add modern theme with dark mode and full-text search - Update Dockerfile for VitePress build process Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
This commit is contained in:
Mahi
98
Documentation/departments/index.md
Normal file
98
Documentation/departments/index.md
Normal file
@@ -0,0 +1,98 @@
|
||||
# Department User Guide
|
||||
|
||||
## Overview
|
||||
|
||||
This guide covers daily operations for department staff processing license applications through TLAS.
|
||||
|
||||
## Logging In
|
||||
|
||||
1. Navigate to your department portal URL
|
||||
2. Enter your department code and API key
|
||||
3. Click "Sign In"
|
||||
|
||||
Your dashboard displays:
|
||||
- Pending applications in your queue
|
||||
- Applications requiring attention (SLA warnings)
|
||||
- Recent activity summary
|
||||
|
||||
## Queue Management
|
||||
|
||||
### Viewing Your Queue
|
||||
|
||||
The main queue shows applications assigned to you:
|
||||
|
||||
| Column | Description |
|
||||
|--------|-------------|
|
||||
| Application ID | Unique identifier |
|
||||
| Applicant | Name and contact |
|
||||
| License Type | Category of license |
|
||||
| Submitted | Date received |
|
||||
| Status | Current stage |
|
||||
| SLA | Time remaining |
|
||||
|
||||
### Filtering and Sorting
|
||||
|
||||
- Filter by status: Pending, In Review, Returned
|
||||
- Filter by license type
|
||||
- Sort by date, SLA urgency, or applicant name
|
||||
- Search by application ID or applicant name
|
||||
|
||||
## Processing Applications
|
||||
|
||||
### Review Checklist
|
||||
|
||||
1. Open application from queue
|
||||
2. Verify applicant information
|
||||
3. Check all required documents are present
|
||||
4. Validate document authenticity
|
||||
5. Review any previous notes or history
|
||||
6. Take action: Approve, Reject, or Return
|
||||
|
||||
### Document Verification
|
||||
|
||||
For each uploaded document:
|
||||
- View full document
|
||||
- Check document type matches requirement
|
||||
- Verify document is legible
|
||||
- Compare with DigiLocker records if available
|
||||
- Add verification notes
|
||||
|
||||
### Taking Action
|
||||
|
||||
**Approve**: Application moves to next stage or final issuance
|
||||
- Requires all documents verified
|
||||
- Add approval notes (optional)
|
||||
|
||||
**Reject**: Application is denied
|
||||
- Select rejection reason from list
|
||||
- Provide detailed explanation
|
||||
- Applicant notified with reason
|
||||
|
||||
**Return**: Application sent back for corrections
|
||||
- Specify what needs correction
|
||||
- Select affected documents
|
||||
- Applicant can resubmit
|
||||
|
||||
## Workflow Stages
|
||||
|
||||
Each license type has defined stages:
|
||||
|
||||
```
|
||||
Document Verification → Technical Review → Supervisor Approval → Issuance
|
||||
```
|
||||
|
||||
Your role determines which stages you can process.
|
||||
|
||||
## Keyboard Shortcuts
|
||||
|
||||
| Key | Action |
|
||||
|-----|--------|
|
||||
| `N` | Next application |
|
||||
| `P` | Previous application |
|
||||
| `A` | Approve (if eligible) |
|
||||
| `R` | Return to applicant |
|
||||
| `/` | Search |
|
||||
|
||||
## Need Help?
|
||||
|
||||
Contact your Department Administrator or IT support for assistance.
|
||||
88
Documentation/departments/issuance.md
Normal file
88
Documentation/departments/issuance.md
Normal file
@@ -0,0 +1,88 @@
|
||||
# License Issuance
|
||||
|
||||
## Issuance Process
|
||||
|
||||
When an application reaches final approval:
|
||||
|
||||
```
|
||||
Final Approval
|
||||
│
|
||||
▼
|
||||
┌─────────────────┐
|
||||
│ System creates │
|
||||
│ license record │
|
||||
└────────┬────────┘
|
||||
│
|
||||
▼
|
||||
┌─────────────────┐
|
||||
│ NFT minted on │
|
||||
│ blockchain │
|
||||
└────────┬────────┘
|
||||
│
|
||||
▼
|
||||
┌─────────────────┐
|
||||
│ Certificate │
|
||||
│ generated (PDF) │
|
||||
└────────┬────────┘
|
||||
│
|
||||
▼
|
||||
┌─────────────────┐
|
||||
│ Applicant │
|
||||
│ notified │
|
||||
└─────────────────┘
|
||||
```
|
||||
|
||||
## Certificate Contents
|
||||
|
||||
Each issued certificate includes:
|
||||
|
||||
| Field | Description |
|
||||
|-------|-------------|
|
||||
| License Number | Unique identifier (GOA/DEPT/YEAR/SERIAL) |
|
||||
| Holder Name | Legal name of licensee |
|
||||
| License Type | Category of license |
|
||||
| Issue Date | Date of issuance |
|
||||
| Valid Until | Expiration date |
|
||||
| Issuing Authority | Department name and officer |
|
||||
| QR Code | Verification link |
|
||||
| Digital Signature | Cryptographic signature |
|
||||
|
||||
## Blockchain Record
|
||||
|
||||
The NFT token contains:
|
||||
|
||||
```json
|
||||
{
|
||||
"tokenId": "0x123...",
|
||||
"licenseNumber": "GOA/TRADE/2026/00001",
|
||||
"documentHash": "SHA256:abc...",
|
||||
"issuedAt": 1707500000,
|
||||
"issuedBy": "0xDeptAddress..."
|
||||
}
|
||||
```
|
||||
|
||||
## Verification
|
||||
|
||||
Anyone can verify a certificate:
|
||||
|
||||
1. Scan QR code on certificate
|
||||
2. Or visit verification portal
|
||||
3. Enter license number
|
||||
4. System queries blockchain
|
||||
5. Displays verification result
|
||||
|
||||
Verification shows:
|
||||
- Valid/Invalid status
|
||||
- License details
|
||||
- Issuance history
|
||||
- Current status (active/expired/revoked)
|
||||
|
||||
## Revocation
|
||||
|
||||
If a license must be revoked:
|
||||
|
||||
1. Department admin initiates revocation
|
||||
2. Reason documented
|
||||
3. Blockchain record updated (token burned)
|
||||
4. Certificate marked as revoked
|
||||
5. Holder notified
|
||||
74
Documentation/departments/processing.md
Normal file
74
Documentation/departments/processing.md
Normal file
@@ -0,0 +1,74 @@
|
||||
# Application Processing
|
||||
|
||||
## Application States
|
||||
|
||||
| State | Description | Actions Available |
|
||||
|-------|-------------|-------------------|
|
||||
| `SUBMITTED` | New application received | Assign, View |
|
||||
| `IN_REVIEW` | Under officer review | Approve, Reject, Return |
|
||||
| `RETURNED` | Sent back for corrections | View (applicant corrects) |
|
||||
| `APPROVED` | All stages complete | Issue certificate |
|
||||
| `REJECTED` | Application denied | View, Appeal (applicant) |
|
||||
| `ISSUED` | Certificate generated | View, Verify |
|
||||
|
||||
## Processing an Application
|
||||
|
||||
### Step 1: Open Application
|
||||
|
||||
From your queue, click on the application row to open the detail view.
|
||||
|
||||
### Step 2: Review Information
|
||||
|
||||
Verify applicant-provided information:
|
||||
- Personal/business details
|
||||
- Contact information
|
||||
- Application-specific data
|
||||
|
||||
### Step 3: Check Documents
|
||||
|
||||
For each required document:
|
||||
1. Click document thumbnail to open full view
|
||||
2. Verify document is legible
|
||||
3. Confirm document type matches requirement
|
||||
4. Check validity dates where applicable
|
||||
5. Compare with DigiLocker records (if available)
|
||||
|
||||
### Step 4: Take Action
|
||||
|
||||
**Approve**
|
||||
- Click "Approve" button
|
||||
- Add comments (optional)
|
||||
- Confirm action
|
||||
- Application moves to next stage
|
||||
|
||||
**Return for Corrections**
|
||||
- Click "Return" button
|
||||
- Select document(s) needing correction
|
||||
- Provide specific correction instructions
|
||||
- Confirm action
|
||||
- Applicant notified to resubmit
|
||||
|
||||
**Reject**
|
||||
- Click "Reject" button
|
||||
- Select rejection reason from list
|
||||
- Provide detailed explanation
|
||||
- Confirm action
|
||||
- Application closed, applicant notified
|
||||
|
||||
## Bulk Actions
|
||||
|
||||
For multiple similar applications:
|
||||
1. Select applications using checkboxes
|
||||
2. Click "Bulk Actions"
|
||||
3. Choose action (Assign, Export)
|
||||
4. Confirm
|
||||
|
||||
Note: Approve/Reject must be done individually.
|
||||
|
||||
## Time Tracking
|
||||
|
||||
System tracks:
|
||||
- Time in current stage
|
||||
- Total processing time
|
||||
- Officer active time on application
|
||||
- SLA remaining
|
||||
67
Documentation/departments/reporting.md
Normal file
67
Documentation/departments/reporting.md
Normal file
@@ -0,0 +1,67 @@
|
||||
# Reporting & Analytics
|
||||
|
||||
## Dashboard Overview
|
||||
|
||||
The department dashboard displays:
|
||||
|
||||
- **Applications Today**: New submissions
|
||||
- **Pending Review**: Items in queue
|
||||
- **Processed Today**: Completed actions
|
||||
- **SLA Alerts**: Approaching deadlines
|
||||
|
||||
## Standard Reports
|
||||
|
||||
### Processing Report
|
||||
|
||||
| Metric | Description |
|
||||
|--------|-------------|
|
||||
| Total Received | Applications submitted |
|
||||
| Total Processed | Approved + Rejected |
|
||||
| Approval Rate | % approved |
|
||||
| Avg. Processing Time | Days from submit to decision |
|
||||
|
||||
### SLA Compliance Report
|
||||
|
||||
| Metric | Description |
|
||||
|--------|-------------|
|
||||
| On-Time | Completed within SLA |
|
||||
| Breached | Exceeded SLA |
|
||||
| Compliance % | On-time / Total |
|
||||
| Avg. Delay | Days over SLA (when breached) |
|
||||
|
||||
### Officer Performance
|
||||
|
||||
| Metric | Description |
|
||||
|--------|-------------|
|
||||
| Processed Count | Applications handled |
|
||||
| Avg. Processing Time | Per application |
|
||||
| Return Rate | % returned for corrections |
|
||||
| SLA Compliance | % within deadline |
|
||||
|
||||
## Generating Reports
|
||||
|
||||
1. Navigate to **Reports** section
|
||||
2. Select report type
|
||||
3. Choose date range
|
||||
4. Apply filters (optional)
|
||||
5. Click **Generate**
|
||||
6. Download as PDF or Excel
|
||||
|
||||
## Scheduled Reports
|
||||
|
||||
Configure automatic report delivery:
|
||||
|
||||
1. Go to **Settings** → **Scheduled Reports**
|
||||
2. Click **Add Schedule**
|
||||
3. Select report type
|
||||
4. Set frequency (daily/weekly/monthly)
|
||||
5. Add recipients
|
||||
6. Save
|
||||
|
||||
## Export Options
|
||||
|
||||
| Format | Use Case |
|
||||
|--------|----------|
|
||||
| PDF | Formal reporting |
|
||||
| Excel | Data analysis |
|
||||
| CSV | System integration |
|
||||
60
Documentation/departments/verification.md
Normal file
60
Documentation/departments/verification.md
Normal file
@@ -0,0 +1,60 @@
|
||||
# Document Verification
|
||||
|
||||
## Verification Methods
|
||||
|
||||
### Manual Review
|
||||
|
||||
Officer visually inspects uploaded documents:
|
||||
- Document legibility
|
||||
- Information consistency
|
||||
- Valid dates
|
||||
- Proper format
|
||||
|
||||
### DigiLocker Verification
|
||||
|
||||
For supported documents:
|
||||
1. Click "Verify with DigiLocker" button
|
||||
2. System fetches document from DigiLocker
|
||||
3. Compares with uploaded version
|
||||
4. Shows match status
|
||||
|
||||
Supported documents:
|
||||
- Aadhaar
|
||||
- PAN Card
|
||||
- Driving License
|
||||
- Vehicle Registration
|
||||
- Academic Certificates (selected universities)
|
||||
|
||||
### Hash Verification
|
||||
|
||||
For previously issued documents:
|
||||
1. System calculates document hash
|
||||
2. Compares with stored hash
|
||||
3. Confirms document integrity
|
||||
|
||||
## Verification Status
|
||||
|
||||
| Status | Meaning |
|
||||
|--------|---------|
|
||||
| ✅ Verified | Document authenticated |
|
||||
| ⚠️ Unverified | Pending manual review |
|
||||
| ❌ Failed | Verification unsuccessful |
|
||||
| ⏳ Processing | Verification in progress |
|
||||
|
||||
## Common Issues
|
||||
|
||||
**Blurry Document**
|
||||
- Return to applicant with clear instructions
|
||||
- Request higher quality scan
|
||||
|
||||
**Expired Document**
|
||||
- Check if license type allows expired documents
|
||||
- Return if valid document required
|
||||
|
||||
**Name Mismatch**
|
||||
- Compare with other documents
|
||||
- Request explanation or corrected document
|
||||
|
||||
**Missing Information**
|
||||
- Identify specific missing fields
|
||||
- Return with detailed requirements
|
||||
80
Documentation/departments/workflows.md
Normal file
80
Documentation/departments/workflows.md
Normal file
@@ -0,0 +1,80 @@
|
||||
# Workflow Management
|
||||
|
||||
## Understanding Workflows
|
||||
|
||||
A workflow defines the approval stages an application passes through before license issuance. Department administrators configure workflows for each license type.
|
||||
|
||||
## Workflow Components
|
||||
|
||||
### Stages
|
||||
|
||||
Each stage represents a review step:
|
||||
|
||||
| Property | Description |
|
||||
|----------|-------------|
|
||||
| Name | Stage identifier (e.g., "Document Verification") |
|
||||
| Order | Sequence position (1, 2, 3...) |
|
||||
| Assignee Rule | Who receives applications at this stage |
|
||||
| Required Actions | What must be completed to proceed |
|
||||
| SLA | Maximum time allowed |
|
||||
|
||||
### Stage Types
|
||||
|
||||
**Sequential**: Applications must pass through in order
|
||||
```
|
||||
Stage 1 → Stage 2 → Stage 3 → Issuance
|
||||
```
|
||||
|
||||
**Parallel**: Multiple reviews happen simultaneously
|
||||
```
|
||||
┌→ Technical Review ─┐
|
||||
Stage 1 ─┤ ├→ Final Approval
|
||||
└→ Financial Review ─┘
|
||||
```
|
||||
|
||||
### Assignment Rules
|
||||
|
||||
- **Round Robin**: Distribute evenly across available officers
|
||||
- **Load Based**: Assign to officer with fewest pending items
|
||||
- **Manual**: Supervisor assigns each application
|
||||
- **Specific Role**: Route to designated role
|
||||
|
||||
## Creating a Workflow
|
||||
|
||||
1. Navigate to **Settings** → **Workflows**
|
||||
2. Click **Create New Workflow**
|
||||
3. Enter workflow name and description
|
||||
4. Add stages in sequence:
|
||||
- Define stage name
|
||||
- Set assignment rule
|
||||
- Configure SLA duration
|
||||
- Specify required documents
|
||||
5. Set workflow as active
|
||||
6. Assign to license type(s)
|
||||
|
||||
## Modifying Workflows
|
||||
|
||||
Changes apply only to new applications. In-progress applications continue with their original workflow.
|
||||
|
||||
To modify:
|
||||
1. Open workflow in editor
|
||||
2. Make changes
|
||||
3. Review impact summary
|
||||
4. Confirm and save
|
||||
|
||||
## SLA Configuration
|
||||
|
||||
| Field | Description |
|
||||
|-------|-------------|
|
||||
| Duration | Hours/days allowed |
|
||||
| Warning | Alert before breach |
|
||||
| Escalation | Action on breach |
|
||||
| Override | Manual extension allowed |
|
||||
|
||||
## Best Practices
|
||||
|
||||
- Keep stages focused on single responsibility
|
||||
- Set realistic SLAs based on actual processing time
|
||||
- Use parallel stages for independent reviews
|
||||
- Document stage requirements clearly
|
||||
- Review workflow performance monthly
|
||||
Reference in New Issue
Block a user