elk icon indicating copy to clipboard operation
elk copied to clipboard

Add code references to layered algorithm blog post for easier navigation

Open ymolists opened this issue 2 weeks ago • 0 comments

Hi team, I recently discovered the excellent blog post on the layered layout algorithm: https://eclipse.dev/elk/blog/posts/2025/25-08-21-layered.html

The post provides fantastic in-depth explanations of how the Eclipse Layout Kernel algorithms function. However, it would be incredibly helpful for developers trying to understand the implementation if direct links to the corresponding source code were included throughout the article. Proposed Enhancement: Could you consider adding inline code references (GitHub permalinks or relative repository links) at relevant sections? This would help readers:

  • Bridge the gap between conceptual understanding and implementation details
  • Navigate the codebase more efficiently when studying specific algorithm phases
  • Reduce friction for contributors looking to understand or modify the algorithms

For example, when discussing specific phases like cycle breaking, layer assignment, or edge routing, linking to the relevant Java classes or methods would significantly improve the documentation's utility. Benefits:

  • Improved developer onboarding experience
  • Better documentation-to-code traceability
  • Enhanced learning path for new contributors
  • Reduced time searching through the repository

Thank you for considering this enhancement, and thanks for the excellent documentation work so far!

ymolists avatar Dec 17 '25 02:12 ymolists