Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Empty file.
8 changes: 8 additions & 0 deletions _specs/websocket-server/v1/assets/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# Assets for this spec

Use this folder for diagrams, images, and attachments referenced by pages in this spec.

Suggested:
- `assets/diagrams/` — draw.io, Excalidraw, PlantUML exports, ERDs
- `assets/images/` — screenshots/static images
- `assets/attachments/` — PDFs, sheets, other binaries
18 changes: 18 additions & 0 deletions _specs/websocket-server/v1/data-model.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
---
layout: spec
title: websocket server — Data Model
nav_title: "Data Model"
nav_order: 25
---
# Data Model
## ERD
- Embed from `assets/diagrams/` or link to an ERD tool export.

## Tables / Collections
- Fields, types, indexes

## Retention / Archival / PII
- Classification & masking

## Example Queries
- …
39 changes: 39 additions & 0 deletions _specs/websocket-server/v1/hld.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
---
layout: spec
title: websocket server — HLD
nav_title: "High-Level Design"
nav_order: 10
---
# HLD
## Context & Goals
- …

## Architecture (diagram)
- Place diagrams under `assets/diagrams/` and embed here.

## Components
| Component | Responsibility | Runs where | Notes |
|---|---|---|---|
| | | | |

## Interactions
- Key request/response flows
- External integrations

## Non-functional Requirements
- Performance, scalability, security, observability

## Constraints & Assumptions
- …

## Alternatives Considered
- …

## Risks & Mitigations
- …

## Dependencies
- …

## Open Questions
- …
37 changes: 37 additions & 0 deletions _specs/websocket-server/v1/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
---
layout: spec
epic: MXOP-3850
family: websocket server
version: v1
title: websocket server
status: in-progress
stage: dev
spec_version: "1.0.0"
owner: "@pranavwani"
team: ""
created_at: 2025-09-11
updated_at:
tags: []
changelog:
- date: 2025-09-11
text: "Initial scaffold from issue #51"
nav_title: "Overview"
nav_order: 0
---
## Summary
websocket server

## Scope
websocket server

## Risks & assumptions
websocket server

## Related Docs
- [High-Level Design](./hld.md)
- [Low-Level Design](./lld.md)
- [Data Model](./data-model.md)
- [Rollout & Ops](./rollout-ops.md)

## Related Links
- websocket server
37 changes: 37 additions & 0 deletions _specs/websocket-server/v1/lld.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
---
layout: spec
title: websocket server — LLD
nav_title: "Low-Level Design"
nav_order: 20
---
# LLD
## Module Breakdown
- Module A/B with public interfaces and internals

## Data Structures & Storage
- Entities/DTOs, schemas, migrations

## Algorithms & State
- Pseudocode / state machines

## Configuration
```yaml
feature_enabled: true
timeout_ms: 5000
retry: { attempts: 3 }
```

## Error Handling
- Taxonomy, retries, idempotency, backoff

## Logging & Instrumentation
- Logs, metrics (names/types/labels), tracing spans

## Security Details
- Permissions, secrets, validation

## I18n/Accessibility (if applicable)
- …

## Edge Cases
- …
18 changes: 18 additions & 0 deletions _specs/websocket-server/v1/rollout-ops.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
---
layout: spec
title: websocket server — Rollout & Ops
nav_title: "Rollout & Ops"
nav_order: 50
---
# Rollout & Ops
## Launch Plan
- Flags/config, migrations/backfill, rollback

## Monitoring & SLOs
- SLIs/SLOs, dashboards, alerts

## Runbook
- On-call steps; rollback strategy

## Post-launch
- Success criteria; cleanup tasks