docToolchain / docToolchain/empty-workshop

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

Open
#4 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
Shell
Stars
5
Forks
38
PR merge metrics
No merged PRs in 30d

Description

## 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

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.