more docs

Author: martypitt

docs/package.json

@@ -1,5 +1,5 @@
 {
-  "name": "nebula-docs",
+  "name": "preflight-docs",
   "version": "1.0.0",
   "description": "",
   "main": "index.js",
@@ -9,7 +9,7 @@
     "start": "next start"
   },
   "author": "",
-  "license": "ISC",
+  "license": "Apache-2.0",
   "dependencies": {
     "next": "^14.2.8",
     "nextra": "^3.2.5",

docs/pages/_meta.ts

@@ -1,3 +1,7 @@
 export default {
+    // Controlling the order these are shown in the sidebar
     "index": "Getting started",
+    "writing-tests" : "Writing tests",
+    "stubbing" : "Stubbing responses",
+    "faq" : "Tips and FAQ's"
 };

docs/pages/faq.mdx

@@ -0,0 +1,62 @@
+---
+title: Tips and FAQs
+---
+# Tips and FAQ's
+
+
+### How do I get the command line to show me the tests that have been run?
+By default, the Gradle output is quite quiet (compared to Maven or other build tools).
+
+To get more information about tests as they're being run, add the following to your `build.gradle.kts`:
+
+```kotlin
+tasks.test {
+    testLogging {
+        events("started", "passed", "failed", "skipped")
+        exceptionFormat = org.gradle.api.tasks.testing.logging.TestExceptionFormat.SHORT
+        showStandardStreams = false
+    }
+}
+```
+
+### Where are the test reports
+ * An HTML browsable output is created at `build/reports/tests/test/index.html`
+ * The standard XML test reports (JUnit style) are at `build/repoirts/test-results/test`
+
+
+### My test failed, but the two numbers look the same
+This is a common issue:
+
+```
+io.kotest.assertions.AssertionFailedError: Values differed at keys amount
+expected:<{
+  "value" = 100
+}> but was:<{
+  "value" = 100
+}>
+```
+
+When types in Taxi are declared as `Decimal`, then they are returned to the JVM as `BigDecimal`.
+
+For example, given the model:
+
+```taxi
+model Purchase {
+  value : Amount inherits Decimal
+}
+```
+
+Then in a test:
+
+```kotlin
+it("should compare decimal numbers") {
+    """
+    given { Purchase = { value: 20 } }
+    find { Purchase }
+    """.queryForObject()
+        .shouldBe(mapOf(
+            "value" to 20, // wrong - don't do this
+            "value" to 20.toBigDecimal(), // correct - do this
+        ))
+}
+```

docs/pages/index.mdx

@@ -28,11 +28,20 @@ plugins {
 }
 ```
 
+You also need a `settings.gradle.kts` (but can be blank)
+
+```kotlin
+// settings.gradle.kts
+// This file can be left blank
+```
+
 Then, to write your first test, create a folder `test` next to your `src` folder.
 By convention, these are named ending in `Spec.kt` or `Test.kt`.
 
 ```kotlin
 // test/HelloWorldSpec.kt
+import com.orbitalhq.preflight.dsl.OrbitalSpec
+import io.kotest.matchers.shouldBe
 
 class HelloWorldSpec : OrbitalSpec({
     describe("First test") {