Skip to content

Commit 2a89de3

Browse files
docs: add debugging page
This explains how I've designed Slyde, and what to do in case of an error.
1 parent 407f3a3 commit 2a89de3

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

docs/debugging.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# Debugging
2+
3+
Slyde is build on the mentality of "let it crash". I will try to make Slyde crash when it reaches an invalid state, and mention where this mistake in the document was. I try to provide you with a path to the invalid node.
4+
5+
For example this obviously does not make sense:
6+
7+
```XML
8+
<presentation title="outer presentation">
9+
<presentation title="inner presentation" />
10+
</presentation>
11+
```
12+
13+
So, you'll receive an error along the lines of `"Expected slides at ${path} but found presentation"` where path is the path to the inner presentation. These paths are based on [xpath](https://www.w3schools.com/xml/xpath_intro.asp), a XML query language. This makes sure we are all on the same page, and might make creating IDE extensions easier later.
14+
15+
In case you do not get a path, that is a shame. Feel free to [open an issue](https://github.com/Tygo-van-den-Hurk/Slyde/issues/new) and I will look into it.

0 commit comments

Comments
 (0)