Skip to content

feat(P6-F001): Add wiki navigation menu to catalog writer#18

Merged
hangtime79 merged 1 commit intomasterfrom
feature/P6-F001-generate-nav-menu
Dec 1, 2025
Merged

feat(P6-F001): Add wiki navigation menu to catalog writer#18
hangtime79 merged 1 commit intomasterfrom
feature/P6-F001-generate-nav-menu

Conversation

@hangtime79
Copy link
Owner

Summary

Implements Phase 6 Feature P6-F001: Wiki Navigation Menu Generation

Adds a navigation menu to wiki articles generated by the Discovery Agent's CatalogWriter to improve article scannability with anchor links to major sections.

Changes

  • New Method: _generate_navigation_menu() in CatalogWriter

    • Generates markdown navigation with anchor links to article sections
    • Includes dynamic counts for datasets and recipes
    • References future sections (Flow Diagram, Technical Details) marked as "Coming soon"
  • Integration: Integrated into generate_wiki_article() after Quick Summary section

    • Conditional generation (only for EnhancedBlockMetadata)
    • Maintains consistent spacing and formatting
  • Tests: Comprehensive unit test coverage

    • Basic functionality test
    • Zero items edge case
    • Large count boundary test

Test Results

  • New tests: 3/3 passing (100%)
  • All catalog writer tests: 40/40 passing (100%)
  • Pre-commit hooks: ✓ black | ✓ ruff

Files Modified

  • dataikuapi/iac/workflows/discovery/catalog_writer.py (+44 lines)
  • tests/iac/workflows/discovery/unit/test_catalog_writer_helpers.py (+53 lines)

Future Work

Navigation menu includes references to sections not yet implemented:

  • Flow Diagram section (Phase 7/8)
  • Technical Details section (Phase 7/8)
  • Update to remove "Coming soon" markers once sections are added

Acceptance Criteria

  • _generate_navigation_menu() method added to CatalogWriter
  • Method generates markdown navigation with section links
  • Dynamic counts for datasets/recipes included
  • Future sections marked with "Coming soon"
  • Integration into generate_wiki_article() after Quick Summary
  • Unit tests pass with 100% coverage for new method
  • Feature branch created from master
  • Commit follows specified format

🤖 Generated with Claude Code

Implements navigation menu generation for wiki articles:
- Add _generate_navigation_menu() helper method
- Generate markdown nav with anchor links to major sections
- Include dynamic counts for datasets/recipes
- Mark future sections (Flow Diagram, Technical Details) as coming soon
- Integrate into generate_wiki_article() after Quick Summary
- Add comprehensive unit tests with boundary cases

Tests: 3/3 passing (100%)
All catalog writer tests: 40/40 passing (100%)

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
@hangtime79 hangtime79 merged commit f452713 into master Dec 1, 2025
4 checks passed
@hangtime79 hangtime79 deleted the feature/P6-F001-generate-nav-menu branch December 1, 2025 12:04
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

Successfully merging this pull request may close these issues.

1 participant