Skip to content

docs: Complete documentation reorganization cleanup #20

@vaceslav

Description

@vaceslav

Summary

Additional cleanup tasks remaining after the documentation split into 'For Template Authors' and 'For Developers' sections.

Note: The main broken links have been fixed in the previous commit. This issue tracks remaining optional cleanup.


Tasks

1. Missing Tutorial Files (Medium Priority)

Multiple documentation files reference tutorials that don't exist yet:

  • Tutorial 3: tutorials/03-conditionals-and-loops.md
  • Tutorial 4: tutorials/04-advanced-features.md

Referenced in:

  • docs/quick-start.md (lines 318-319)
  • docs/tutorials/01-hello-world.md (lines 471-472)
  • docs/tutorials/02-invoice-generator.md (lines 503-504)

Options:

  • Create stub files with "Coming Soon" placeholders
  • Remove references to these tutorials from all files
  • Create the actual tutorial content (requires more effort)

Recommendation: Option 1 or 2 depending on timeline for creating actual content.


2. Legacy Guides Directory (Low Priority)

The docs/guides/ directory still exists but is now obsolete:

  • Only contains index.md (50+ lines referencing moved content)
  • All actual guide content was moved to docs/for-template-authors/
  • Creates ambiguity about documentation structure

Options:

  • Delete docs/guides/index.md and the directory
  • Update docs/guides/index.md to redirect/explain new structure
  • Keep for backwards compatibility (not recommended)

Recommendation: Delete the directory to avoid confusion.

File to remove:

  • docs/guides/index.md

3. Developer Documentation Section (Future Enhancement)

The docs/for-developers/ section currently contains only a placeholder:

  • docs/for-developers/quick-start.md - "Coming Soon" stub linking to existing docs

Future work:

  • Create full developer quick-start guide with C# examples
  • Add installation guide
  • Add API reference documentation
  • Add code examples
  • Add architecture overview
  • Add performance guide

Note: This is intentional placeholder for future work, not urgent.


Impact

User Experience:

  • Missing tutorials: Users may click broken links or be confused by references to non-existent content
  • Legacy directory: Potential confusion about where documentation lives
  • Developer placeholder: Intentional, clearly marked as "Coming Soon"

Build Status:

  • MkDocs builds successfully
  • Warnings present but non-blocking

Estimated Effort

  • Task 1 (Remove tutorial references): 10 minutes
  • Task 2 (Delete guides/ directory): 5 minutes
  • Task 3 (Developer docs): Multiple hours (future work)

Total for Tasks 1-2: ~15 minutes


Labels

  • documentation
  • enhancement
  • good first issue (for Tasks 1-2)

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationenhancementNew feature or request

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions