Skip to content

Convert CSE FAST UDP specification from text to Markdown format#1

Merged
smaruf merged 3 commits intomainfrom
copilot/fix-51281cf3-c220-4001-95e0-b55402568221
Jul 29, 2025
Merged

Convert CSE FAST UDP specification from text to Markdown format#1
smaruf merged 3 commits intomainfrom
copilot/fix-51281cf3-c220-4001-95e0-b55402568221

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Jul 29, 2025

This PR converts the existing technical specification document src/nasdaq/doc/cse_fast_udp.txt into a properly formatted Markdown file src/nasdaq/doc/cse_fast_udp.md to improve readability and accessibility.

Changes Made

  • Document Structure: Converted the 3000+ line text document into well-organized Markdown with proper heading hierarchy (#, ##, ###, ####)
  • Table Formatting: Transformed all tabular data into proper Markdown tables, including:
    • Message format specifications
    • Field definitions and encodings
    • Statistics tables (Book-Level, Market and Sector)
    • Instrument classifications
    • Trading halt reason codes
    • Reject codes and error mappings
  • Enhanced Readability: Added proper formatting for:
    • Code blocks and technical field references
    • System architecture diagram (ASCII art)
    • Document control information and revision history
    • Definition tables for acronyms and abbreviations
  • Navigation: Created a comprehensive table of contents with anchor links for easy navigation
  • Content Preservation: Maintained all original technical content including:
    • Complete revision history from v1.00 to v1.07
    • All message templates and field specifications
    • Trading session workflows and timing
    • Recovery procedures and channel descriptions

Technical Details

The converted document includes detailed specifications for the Chittagong Stock Exchange Market Data Feed (FAST/UDP v1.07), covering:

  • Real-time market data dissemination via UDP multicast
  • TCP recovery channels (Snapshot and Replay)
  • FIX 5.0 message formats with FAST encoding
  • Order book management (both price and order depth)
  • Trading statistics and index calculations
  • Administrative and application message specifications

File Information

  • Original: src/nasdaq/doc/cse_fast_udp.txt (115KB, 3000+ lines)
  • New: src/nasdaq/doc/cse_fast_udp.md (33KB, 517 lines of formatted Markdown)

The Markdown version provides the same comprehensive technical information in a more accessible and readable format, making it easier for developers and technical stakeholders to reference the specification.

This pull request was created as a result of the following prompt from Copilot chat.

Convert the existing text file src/nasdaq/doc/cse_fast_udp.txt into a Markdown file src/nasdaq/doc/cse_fast_udp.md with proper formatting. This involves:

  • Converting major sections into Markdown headings (e.g., #, ##, ###)
  • Formatting tables using Markdown syntax where appropriate
  • Preserving lists and document structure
  • Ensuring technical terms and code/text blocks are correctly formatted
  • Keeping all content, including document control, revision history, and specification details

The new file should reside at src/nasdaq/doc/cse_fast_udp.md and retain all original information, but with enhanced readability for Markdown.

Once completed, the file will be downloadable from the repository.


💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

Copilot AI and others added 2 commits July 29, 2025 10:10
… Markdown

Co-authored-by: smaruf <10070242+smaruf@users.noreply.github.com>
…ey sections

Co-authored-by: smaruf <10070242+smaruf@users.noreply.github.com>
Copilot AI changed the title [WIP] Convert cse_fast_udp.txt to a properly formatted Markdown file Convert CSE FAST UDP specification from text to Markdown format Jul 29, 2025
Copilot AI requested a review from smaruf July 29, 2025 10:16
@smaruf smaruf marked this pull request as ready for review July 29, 2025 18:48
@smaruf smaruf merged commit b3a9e66 into main Jul 29, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants