Skip to content

Restructure README and DOCKER.md for improved readability#72

Merged
valITino merged 1 commit intomainfrom
claude/polish-docs-formatting-mq2SC
Mar 13, 2026
Merged

Restructure README and DOCKER.md for improved readability#72
valITino merged 1 commit intomainfrom
claude/polish-docs-formatting-mq2SC

Conversation

@valITino
Copy link
Owner

Summary

Reorganized documentation files to improve navigation, readability, and information hierarchy. Converted the table of contents from a flat bullet-point list to a categorized table format, simplified prose throughout, and standardized formatting conventions across both README.md and DOCKER.md.

Key Changes

README.md

  • Table of Contents: Converted from 24-item bullet list to a 6-row categorized table (Getting Started, Tutorials, Reference, Operations, Security, Project) with dot-separated links for better scannability
  • Prose simplification: Condensed multi-line explanations into single-line summaries throughout (e.g., "How It Works", "Architecture", "Prerequisites")
  • Architecture diagram: Replaced ASCII pipes (|, v) with Unicode box-drawing characters (, , ├──, ) for cleaner visual hierarchy
  • Components section: Converted from prose table to a cleaner 7-row table with consistent column alignment
  • Output Files section: Simplified table headers and reduced explanatory text
  • Installation instructions: Reorganized manual setup steps with clearer numbering and condensed explanatory text
  • Tutorial sections: Standardized step numbering format (e.g., "Step 1 —" instead of "Step 1:") and removed redundant explanations
  • Troubleshooting: Condensed common issues and solutions with tighter formatting
  • CLI Reference & Makefile Shortcuts: Converted from code blocks to aligned tables for easier scanning
  • Prompt Flow diagram: Replaced ASCII arrows with Unicode characters and simplified step descriptions
  • MCP Gateway table: Simplified column headers and reduced text verbosity
  • Neo4j, Authorization, and Security sections: Condensed explanations while preserving essential information

DOCKER.md

  • Title: Changed from # crhacky/blhackbox to # BLHACKBOX — Docker Reference for clarity
  • Metadata table: Converted from bullet list to structured key-value table with link to Docker Hub
  • Images & Tags section: Converted image list from prose to organized tables with consistent formatting
  • Architecture diagrams: Updated ASCII arrows to Unicode characters (──▶, ) for consistency
  • Compose Services table: Standardized column alignment and formatting
  • Image Details: Restructured each image subsection (Kali MCP, WireMCP, Screenshot MCP, Claude Code) from prose lists to organized key-value tables with consistent structure
  • Portainer section: Converted from prose to key-value table format
  • Volumes section: Split into two subsections (named volumes and host bind mounts) with clearer table formatting

Notable Implementation Details

  • Maintained all technical content and accuracy while improving visual presentation
  • Standardized table formatting across both files using consistent markdown syntax (:--: for center alignment, :-- for left alignment)
  • Replaced em-dashes and inconsistent punctuation with standardized Unicode characters for ASCII diagrams
  • Preserved all links, code blocks, and technical specifications
  • Improved information hierarchy through consistent use of tables for structured data

https://claude.ai/code/session_01Y98MjXqwEby44mfgvqiAgd

- Restructure ToC into a compact grouped table layout
- Replace raw badge lines with centered header block + badges
- Standardize all tables with left-aligned columns
- Use Unicode arrows (▶, │, ▼) in architecture/flow diagrams
- Convert Makefile shortcuts from code block to a proper table
- Restructure DOCKER.md image details into key-value tables
- Improve section headers with em-dash separators for tutorials
- Tighten prose and remove redundant wording throughout
- Keep ASCII art banner as-is per user preference

https://claude.ai/code/session_01Y98MjXqwEby44mfgvqiAgd
@valITino valITino marked this pull request as ready for review March 13, 2026 17:42
@valITino valITino merged commit bef9836 into main Mar 13, 2026
2 checks passed
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