work on documentation

This commit is contained in:
Lennart
2025-04-17 21:29:36 +02:00
parent f8e83971dd
commit 92dc69fdef
6 changed files with 38 additions and 52 deletions

View File

@@ -0,0 +1,16 @@
# Debugging
Set the log level with following environment variables:
```sh
RUST_LOG="debug"
RUST_BACKTRACE=1
```
RustiCal also supports exporting opentelemetry traces to inspect with tools like [Jaeger](https://www.jaegertracing.io/).
To enable you need to compile with the `opentelemtry` (or `debug`) feature and enable opentelemetry in the config with
```toml
[tracing]
opentelemetry = true
```

1
docs/developers/index.md Normal file
View File

@@ -0,0 +1 @@
# Developers

13
docs/developers/rfcs.md Normal file
View File

@@ -0,0 +1,13 @@
# RFCs
Collection of RFCs relevant to this project
- Versioning Extensions to WebDAV: [RFC 3253](https://datatracker.ietf.org/doc/html/rfc3253)
- provides the REPORT method
- Calendaring Extensions to WebDAV (CalDAV): [RFC 4791](https://datatracker.ietf.org/doc/html/rfc4791)
- Scheduling Extensions to CalDAV: [RFC 6638](https://datatracker.ietf.org/doc/html/rfc6638)
- not sur`e yet whether to implement this
- Collection Synchronization WebDAV [RFC 6578](https://datatracker.ietf.org/doc/html/rfc6578)
- We need to implement sync-token, etc.
- This is important for more efficient synchronisation
- iCalendar [RFC 2445](https://datatracker.ietf.org/doc/html/rfc2445#section-3.10)

View File

@@ -1,3 +0,0 @@
# RFCs
Collection of RFCs relevant to this project