Merge pull request #639 from derbyjs/troubleshooting-guide

Integrate troubleshooting guide into doc site nav
derbyjs · May 31, 2024 · d12f1c5 · d12f1c5
2 parents 8da2fb8 + 2605fac
commit d12f1c5
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 5 deletions.
diff --git a/docs/README.md b/docs/README.md
@@ -11,7 +11,7 @@ Jekyll has a dev server, which will auto-build the docs upon any changes to the
 Setup:
 
 ```
-cd derby-docs && bundle install
+cd docs && bundle install
 ```
 
 Run the dev server:

diff --git a/docs/guides.md b/docs/guides.md
@@ -0,0 +1,5 @@
+---
+layout: default
+title: Guides
+has_children: true
+---
diff --git a/docs/guides/troubleshooting.md b/docs/guides/troubleshooting.md
@@ -1,3 +1,9 @@
+---
+layout: default
+title: Troubleshooting
+parent: Guides
+---
+
 # Troubleshooting
 
 This guide covers common issues that you may run into as you use Derby. Feel free to contribute your own troubleshooting experience! :)
@@ -14,7 +20,7 @@ Attaching bindings failed, because HTML structure does not match client renderin
 
 When the page is rendered server side and is sent down to the client, Derby it will ensure that both HTML structures are exactly the same before attaching. If they don't match that is usually because the browser's parser attempts to gracefully handle invalid HTML that you may have introduced by mistake. For example, the following syntax is valid XML syntax but invalid HTML:
 
-```html
+```jinja
 <p>
   <div>
   </div>
@@ -23,7 +29,7 @@ When the page is rendered server side and is sent down to the client, Derby it w
 
 Browsers will effectively turn this into:
 
-```html
+```jinja
 <p></p>
 <div></div>
 ```
@@ -36,15 +42,15 @@ source: https://www.w3.org/TR/html401/struct/text.html#edef-P
 
 The same goes for HTML tables where:
 
-```html
+```jinja
 <table>
   <td></td>
 </table>
 ```
 
 ... may be rendered by a browser as:
 
-```html
+```jinja
 <table>
   <tbody>
     <tr>