Skip to content

Links inside annotated code snippet are titled incorrectly #38432

Closed
@zhforge

Description

@zhforge

Code of Conduct

What article on docs.github.com is affected?

https://docs.github.com/en/actions/use-cases-and-examples/creating-an-example-workflow#understanding-the-workflow-file

What part(s) of the article would you like to see updated?

The links inside the "Understanding the workflow file" annotated code snippet do link to the correct place, but have the text "AUTOTITLE" in the beside view and the inline view shows the link's raw markdown syntax. Because annotations can be shown as comments and the raw markdown is visible, I don't think they should have links in them. Since they all link to the "Workflow syntax" page, a link to that page could just be included before or after the code snippet.

Additional information

Image

Image

Metadata

Metadata

Assignees

No one assigned

    Labels

    contentThis issue or pull request belongs to the Docs Content teamgithub_actionsPull requests that update GitHub Actions code

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions