Skip to content

Replace example code blocks with readable alternatives that support word wrap #49

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
bhouston opened this issue Mar 7, 2025 · 1 comment

Comments

@bhouston
Copy link
Member

bhouston commented Mar 7, 2025

Issue: Example code blocks in documentation lack word wrap making them unreadable

Problem

In the examples section of the documentation, there are many code blocks showing example prompts. These code blocks (created using triple backticks) don't have word wrap, making them difficult to read as text extends beyond the visible area.

Affected Files

The issue appears in multiple example files including:

  • docs/examples/effective-techniques.md
  • docs/examples/project-management.md
  • docs/examples/code-development.md
  • docs/examples/devops.md
  • docs/examples/code-review.md

Proposed Solution

Replace the current code blocks with an alternative formatting that:

  1. Maintains clear visual separation from regular text
  2. Supports word wrap
  3. Preserves the content's readability

Possible alternatives include:

  • Using blockquotes (with >) instead of code blocks
  • Using a custom styled div or admonition component that supports word wrap
  • Configuring CSS to enable word wrap in code blocks

Impact

This change will significantly improve readability of the example prompts, making them more accessible and useful to users of the documentation.

@bhouston
Copy link
Member Author

I manually added returns to get around this issue.

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

No branches or pull requests

1 participant