File tree Expand file tree Collapse file tree 1 file changed +20
-0
lines changed
Expand file tree Collapse file tree 1 file changed +20
-0
lines changed Original file line number Diff line number Diff line change @@ -98,6 +98,26 @@ In code samples:
9898 * css
9999 * handlebars
100100
101+ When linking to topics from guide md files:
102+
103+ * use relative links when referencing a topic.
104+ * Incorrect: ` https://guides.emberjs.com/release/routing/query-params/ `
105+ * Correct: ` ../routing/query-params `
106+
107+ * to reference a topic when you are in ` index.md ` , you only have to go up one level to reference another topics md file, ` ../main-topic/sub-topic ` .
108+ * example from ` index.md ` to ` routing/query-params.md ` :
109+ * ` ../routing/query-params `
110+
111+ * to reference a md file in a different main topic to the one you are in, you need to go two levels up, ` ../../main-topic/sub-topic ` .
112+ * example from ` routing/query-params.md ` to ` components/block-params.md ` :
113+ * ` ../../components/block-params `
114+
115+ * to reference a md file within the topic you are currently in, you need to go up one level, ` ../sub-topic ` .
116+ * example from ` routing/query-params.md ` to ` routing/redirection.md ` :
117+ * ` ../redirection `
118+
119+ * always use ` /release/ ` when linking API docs.
120+
101121When linking to API pages:
102122
103123* use code backticks as part of the link text, i.e., \[ <code >` ; store.push()` ; </code >]
You can’t perform that action at this time.
0 commit comments