You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: source/developers/website.markdown
+16Lines changed: 16 additions & 0 deletions
Original file line number
Diff line number
Diff line change
@@ -63,6 +63,12 @@ Content...Written in markdown.
63
63
64
64
There are [pre-definied variables](https://jekyllrb.com/docs/variables/) available but usually, it's not necessary to use them when writing documentation.
65
65
66
+
A couple of points to remember:
67
+
68
+
- Document the needed steps to retrieve API keys or access token for the third party service or device if needed.
69
+
- Keep the configuration sample minimal by only adding the `Required` options. Full configuration details with further explanations should go into a seperate section.
70
+
- The description of all the configuration variables should contains information about the used defaults.
71
+
66
72
### {% linkable_title Embedding Code %}
67
73
68
74
You can use the default markdown syntax to generate syntax highlighted code. For inline code wrap your code in \`. For multi-line, syntax wrap your code as shown below.
@@ -94,6 +100,16 @@ The direct usage of HTML is supported but not recommended. The note boxes are an
94
100
</p>
95
101
```
96
102
103
+
### {% linkable_title Redirects %}
104
+
If you rename or move an existing platform or component, create the redirect. Add the old location of the page to the header of the new one.
105
+
106
+
```test
107
+
---
108
+
...
109
+
redirect_from: /getting-started/android/
110
+
---
111
+
```
112
+
97
113
### {% linkable_title Images, icons, and logos %}
98
114
99
115
The images which are displayed on the pages are stored in various directories according to their purpose.
0 commit comments