Skip to content

Show how to do internal guides links in CONTRIBUTING.md #179

@jenweber

Description

@jenweber

Whenever one section of the guides links to another section, it should use relative links. Please add a section to CONTRIBUTING.md that shows people how to make these links.

Incorrect: https://guides.emberjs.com/release/routing/query-params/
Correct: ../routing/query-params/

The catch is that if you're in an index.md, you only need to go up one level to reference something in another topic, i.e. ../main-topic/subtopic. If you are in a md file of another name, and you want to link to another topic, it's two levels, ../../main-topic/subtopic. If the pages are in the same main topic, the link is ../subtopic. Your PR should include examples.

Include a note that API docs links should go to /release/. For now.

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions