Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Integrate troubleshooting guide into doc site nav #639

Merged
merged 6 commits into from
May 31, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
5 changes: 5 additions & 0 deletions docs/guides.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
layout: default
title: Guides
has_children: true
---
14 changes: 10 additions & 4 deletions docs/guides/troubleshooting.md
Original file line number Diff line number Diff line change
@@ -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! :)
Expand All @@ -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>
Expand All @@ -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>
```
Expand All @@ -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>
Expand Down
Loading