[go: up one dir, main page]
Skip to content

Linkify URLs in Code.

Problem to solve

Make it easier to follow links in code (and other text documents). Especially links in doc-comments and other helpful places.

This will occur in all places that source files are shown, including repo browser, code review and snippets.

Intended users

  • Delaney (Development Team Lead)
    • When reviewing code and API proposals following links will speed up the process.
  • Sasha (Software Developer)
    • When reviewing code and API proposals following links will speed up the process.
    • When writing code can provide links to long-form documentation and explanations.
  • Devon (DevOps Engineer)
    • When reading configuration can follow links to explanations of why the values are set a given way.
    • When editing configuration files can leave links to explanations of why the values are set this way.
  • Sidney (Systems Administrator)
    • See DevOps.
  • Sam (Security Analyst)
    • Can follow links in code documentation to validate the algorithms and logic being used.
    • Can link to security policies from relevant locations in code and config.

Permissions and Security

No permissions are required. Only whitelisted URL schemes should be supported for security reasons.

Documentation

No documentation is required. The feature is self-discoverable.

What does success look like, and how can we measure that?

Links in code files are clickable.

What is the type of buyer?

This helps everyone interacting with source files, but will be especially useful to larger teams where documentation is more critical and referring to external documentation and designs are more common.

Links / references

For example see https://cs.chromium.org/chromium/src/.gn?l=470&rcl=77c566f89247937066860b98e2a81929f4fe8f31 how clickable links can be incredibly useful.