Skip to content

Conversation

@anibal
Copy link
Owner

@anibal anibal commented Nov 11, 2025

…er references

Applied KISS principle to make documentation more resilient to code changes:

  • Replaced all line number references (e.g., file.ts:84-93) with function names and file paths (e.g., addGlobalPageResources() in file.ts)
  • Fixed plugin count comments: filters 3→2, emitters 14→12
  • Added "How to Navigate Code References" section explaining the approach and teaching developers how to find functions in their IDE

Benefits:

  • Documentation survives refactoring without becoming stale
  • Function names are more intuitive than line coordinates
  • Reduces long-term maintenance burden
  • IDE-friendly navigation (symbol search, go-to-definition)

Changes made:

  • explorer.inline.ts references now point to toggleExplorer() function
  • componentResources.ts references now point to addGlobalPageResources() and buildGraphBundle() functions
  • graph-loader.inline.ts references now point to loadGraphBundle() function
  • Plugin count comments corrected in directory tree diagram

…er references

Applied KISS principle to make documentation more resilient to code changes:

- Replaced all line number references (e.g., file.ts:84-93) with function names
  and file paths (e.g., addGlobalPageResources() in file.ts)
- Fixed plugin count comments: filters 3→2, emitters 14→12
- Added "How to Navigate Code References" section explaining the approach
  and teaching developers how to find functions in their IDE

Benefits:
- Documentation survives refactoring without becoming stale
- Function names are more intuitive than line coordinates
- Reduces long-term maintenance burden
- IDE-friendly navigation (symbol search, go-to-definition)

Changes made:
- explorer.inline.ts references now point to toggleExplorer() function
- componentResources.ts references now point to addGlobalPageResources()
  and buildGraphBundle() functions
- graph-loader.inline.ts references now point to loadGraphBundle() function
- Plugin count comments corrected in directory tree diagram
@anibal anibal merged commit f70b7d8 into v4 Nov 11, 2025
3 checks passed
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.

3 participants