Documentation - PhenoApps/Field-Book GitHub Wiki

We use Docsify and git pages to generate the user documentation from markdown (.md) files in in the /docs directory. These markdown files should be updated as part of a pull request if the code changes in the request result in changes to app appearance and behavior. This is acomplished by editing existing markdown files, or adding new ones and including them in the sidebar.md file. Images, gifs, and icons referenced within the markdown files should be stored in the _static subdirectory.

For consistency screenshots should be framed and taken using a Pixel 8a as the virtual device.

If screenshots need to be manipulated use ImageMagick's command line tool convert for consistency and simplicity. For example to join multiple screenshots into one image first add transparent borders

convert screenshot1.png -bordercolor none -border 90x10 bordered1.png
convert screenshot2.png -bordercolor none -border 90x10 bordered2.png
convert screenshot3.png -bordercolor none -border 90x10 bordered3.png

then join them side by side

convert bordered1.png bordered2.png bordered3.png +append joined_screenshots.png

If another type of image or just a partial screenshot is needed then crop and apply a 2pt black border with

convert cropped_screenshot.png -bordercolor black -border 2 bordered_cropped_screenshot.png

Review how any changes to these files are rendered by using editor plugins like VSCode's docsify-Preview or on the command line by running docsify serve docs within the Field-Book directory, then navigating to http://localhost:3000 in a browser.