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: docs/dev-corner/development-projects/documentation.md
+41-1Lines changed: 41 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -233,11 +233,51 @@ If you would like to fully test a complete build of the production website, you
233
233
- Write documentation professionally and clearly.
234
234
- Write for the targeted audience (Sim Beginner, Sim Veteran, Developers, etc.) and don't assume too much pre-knowledge on the reader's side.
235
235
- Use the full availability of features baked into [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/){target=new} to create readable and well formatted guides.
236
-
- Add illustrations where appropriate. Make sure you optimize images to be as small as possible (resize to their actually used size and use JPG Compression (50% is mostly ok)).
236
+
- Add illustrations where appropriate. Make sure you optimize images to be as small as possible (resize to their actually used size and use JPG Compression (50% is mostly ok)).
237
+
See [Image Assets Process](#image-assets-process) for more information.
237
238
- Ensure relevant filenames are web-friendly slugs.
238
239
- Don't hesitate to get feedback from the FlyByWire Documentation Team early and often.
239
240
- Proofread your work carefully before marking "Ready for Review".
- If you think the original is worth it store it in `/src/assets` - but most images aren't worth it as screenshots are quickly retaken (Keeping a local copy of all your screenshots
247
+
is good practice just in case - but it is not worth to clutter the repo with them)
248
+
- Put the edited image in the folder for the topic - e.g. `\docs\pilots-corner\assets\advanced-guides\vnav` for images related to the VNAV topic
249
+
- Link the image in the markdown document - decide on the size you need (See admonition below for references)
250
+
251
+
!!! tip ""
252
+
Width of images on docs based on the responsive layout.
253
+
254
+
| Size | Width |
255
+
|:-----|:-------|
256
+
| 100% | 826 px |
257
+
| 95% | 785 px |
258
+
| 90% | 743 px |
259
+
| 85% | 702 px |
260
+
| 80% | 661 px |
261
+
| 75% | 620 px |
262
+
| 70% | 578 px |
263
+
| 65% | 537 px |
264
+
| 60% | 496 px |
265
+
| 55% | 454 px |
266
+
| 50% | 413 px |
267
+
| 45% | 372 px |
268
+
| 40% | 330 px |
269
+
| 35% | 289 px |
270
+
| 30% | 248 px |
271
+
| 25% | 206 px |
272
+
| 20% | 165 px |
273
+
| 15% | 124 px |
274
+
| 10% | 83 px |
275
+
| 5% | 41 px |
276
+
277
+
- Change the size according to the table - max width is 826 px
278
+
- Compress the png image with a tool - [Website Planet Image Compressor](https://www.websiteplanet.com/webtools/imagecompressor/)
279
+
- Make sure size and quality are good - usually < 100 kB
280
+
241
281
#### Style
242
282
243
283
- Use the units of measurement and their abbreviations as used by ICAO Annex 5. This document can be downloaded, for example, on the website of the [Swiss Federal Office of Civil Aviation](https://www.bazl.admin.ch/bazl/en/home/themen/legislation/anhaenge-icao.html){target=new}.
0 commit comments