search

balena-os / leviathan

A distributed hardware testing framework
https://balena-os.github.io/leviathan
Apache License 2.0
22 stars 6 forks source link

minor: Add general FAQ to Leviathan #1142

Closed vipulgupta2048 closed 3 months ago

vipulgupta2048 commented 3 months ago

Add basic FAQ to debug leviathan issues and answer common questions

Signed-off-by: Vipul Gupta (@vipulgupta2048) vipulgupta2048@gmail.com

rcooke-warwick commented 3 months ago

@vipulgupta2048 there is potentially some overlap with: https://github.com/balena-os/leviathan/blob/master/documentation/quickstart-autokit.md#troubleshooting

Perhaps some of that could be moved into your troubleshooting tips so they're all in one place?

rcooke-warwick commented 3 months ago

lgtm

there were some @page references that didn't render to anything in the markdown preview - are those only visible in the final docusaurus page I'm guessing?

vipulgupta2048 commented 3 months ago

Yes, these are links that get rendered by typedoc automatically. We aren't using Docusaurus atm. That's the next change I am going to be making.

vipulgupta2048 commented 3 months ago

@balena-ci I self-certify!