Dynamic References to Code Symbol Definitions in README.md files

[jacob-wolf]

🏷️ Discussion Type

Product Feedback

💬 Feature/Topic Area

Code Search and Navigation

Body

Github already analyzes the repository for code symbols and their definitions in many languages. It would be nice to be able to dynamically link a reference to those symbol definitions from readme documents in place of listing the line numbers.

Currently this must be done statically by referencing a particular line number. This requires any references to code symbols to have their referenced line numbers updated manually each time the underlying document changes in a way that shifts the particular line numbers for the desired symbol reference.

[github-actions[bot]]

💬 Your Product Feedback Has Been Submitted 🎉

Thank you for taking the time to share your insights with us! Your feedback is invaluable as we build a better GitHub experience for all our users.

Here's what you can expect moving forward ⏩

• Your input will be carefully reviewed and cataloged by members of our product teams. 
  • Due to the high volume of submissions, we may not always be able to provide individual responses.
  • Rest assured, your feedback will help chart our course for product improvements.
• Other users may engage with your post, sharing their own perspectives or experiences. 
• GitHub staff may reach out for further clarification or insight. 
  • We may 'Answer' your discussion if there is a current solution, workaround, or roadmap/changelog post related to the feedback.

Where to look to see what's shipping 👀

• Read the Changelog for real-time updates on the latest GitHub features, enhancements, and calls for feedback.
• Explore our Product Roadmap, which details upcoming major releases and initiatives.

What you can do in the meantime 💻

• Upvote and comment on other user feedback Discussions that resonate with you.
• Add more information at any point! Useful details include: use cases, relevant labels, desired outcomes, and any accompanying screenshots.

As a member of the GitHub community, your participation is essential. While we can't promise that every suggestion will be implemented, we want to emphasize that your feedback is instrumental in guiding our decisions and priorities.

Thank you once again for your contribution to making GitHub even better! We're grateful for your ongoing support and collaboration in shaping the future of our platform. ⭐

[KasraK2K]

Solution: GitHub Symbol References

Great feature request! GitHub actually has some built-in capabilities for this already:

Current Solutions:

1. Permalink Anchors with Line Numbers
You can use URLs like:

https://github.com/owner/repo/blob/main/file.js#L10-L15

2. Symbol Navigation via Go to Symbol
Press T or . in the repository to open the symbol search, which helps locate functions/classes quickly.

3. Code Search
Use GitHub's code search (Ctrl+Shift+K) to find symbols by name across your repository.

Workaround for Dynamic References:

You can create links that use GitHub's symbol search functionality:

[Visit MyFunction](https://github.com/owner/repo?q=function+MyFunction)

Better Approach - Using Stable Permalinks:

GitHub generates stable commit-based permalinks when you click "Copy permalink" on a line. While line numbers change, commit SHAs don't, so:

https://github.com/owner/repo/blob/abc123def456.../file.js#L10

This will always point to the same code even if you're on a different branch.

Feature Request Enhancement:

Your request for true symbol resolution would be valuable - allowing markdown like [MyFunction](symbol://MyFunction) that resolves dynamically. I'd recommend:

• Adding use cases showing how this would improve documentation
• • Mentioning languages you'd want supported
• • Linking related discussions about code documentation
    This is excellent feedback for GitHub's product team! 🎉