Skip to content

Enhance deep-dive-solution.adoc with more AsciiDoc examples #4

@raifdmueller

Description

@raifdmueller

Description

The current deep-dive-solution.adoc provides a good foundation for AsciiDoc examples, but it could be improved with more comprehensive examples to help workshop participants better understand AsciiDoc's capabilities.

Proposed Enhancements

Add more examples for:

  • Advanced table formatting (column spans, row spans, alignment)
  • More diagram types (sequence diagrams, component diagrams, etc.)
  • AsciiDoc extensions and macros
  • Cross-referencing between documents
  • Conditional content inclusion
  • Advanced formatting features like callouts and sidebars
  • Document structuring best practices
  • Tips for optimizing AsciiDoc documents

Purpose

These additions will make the workshop more valuable for participants by exposing them to more advanced features of AsciiDoc that they may need in their documentation projects.

Acceptance Criteria

  • All examples should be functional and well-documented
  • Each feature should include a brief explanation of when and why to use it
  • Examples should follow AsciiDoc best practices
  • Code should be properly formatted and tested

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions