Enhance deep-dive-solution.adoc with comprehensive AsciiDoc examples (#4) #5
Conversation
This commit adds more comprehensive AsciiDoc examples to the deep-dive-solution.adoc file, addressing issue docToolchain#4. Enhancements include: - Advanced table formatting (with column spans, row spans, alignment) - More diagram types (sequence diagrams, component diagrams, mermaid, graphviz) - AsciiDoc extensions and macros - Cross-referencing between documents - Conditional content inclusion - Advanced formatting with callouts and sidebars - Document structuring best practices - Tips for optimizing AsciiDoc documents - Math notation examples - Collapsible blocks - Custom styling via roles Each section includes practical examples with explanations of when and why to use specific features.
|
Hi @rdmueller, I've created this PR to address issue #4. The enhanced The document is structured to serve as both a reference and a learning resource for workshop participants. Each section builds on the previous ones, starting with basic formatting and progressing to more advanced topics. Key improvements:
All examples are fully functional and follow AsciiDoc best practices. Let me know if you'd like any adjustments! |
There was a problem hiding this comment.
Pull Request Overview
This PR enhances the documentation by adding comprehensive AsciiDoc examples and updates the installation instructions to include Java as a prerequisite.
- Introduces
./dtcw install javain the README to ensure a local JDK is available before installing the DocToolchain. - (Other changes to
deep-dive-solution.adocare described in the PR metadata.)
| ---- | ||
| curl -Lo dtcw doctoolchain.github.io/dtcw | ||
| chmod +x dtcw | ||
| ./dtcw install java |
There was a problem hiding this comment.
Consider adding a brief note explaining that this step installs a local JDK required by DocToolchain.
| ./dtcw install java | |
| ./dtcw install java | |
| // This step installs a local JDK, which is required for DocToolchain to function. |
|
|
||
| AsciiDoc automatically handles: | ||
|
|
||
| * Typographic quotes: "curly quotes" (instead of "straight quotes") |
There was a problem hiding this comment.
sollten hier und in den folgenden Zeilen die AsciiDoc-Beispiele nicht escaped werden?
|
|
||
| [cols="1,2,3", options="header"] | ||
| |=== | ||
| |Column 1 (10%) |
There was a problem hiding this comment.
stimmt das so mit den Prozentangaben?
2 participants
This PR enhances the
deep-dive-solution.adocfile with more comprehensive AsciiDoc examples as requested in issue #4.Enhancements
Advanced table formatting
More diagram types
AsciiDoc extensions and macros
Cross-referencing
Conditional content inclusion
Advanced formatting features
Document structuring best practices
Mathematical notation
Each feature includes explanations about when and why to use it, following the acceptance criteria. The examples are functional and well-documented, following AsciiDoc best practices.
Testing
The examples have been tested for correct AsciiDoc syntax and rendering.
Fixes #4