public/obsidian-livesync
1
0
Fork 0
mirror of https://github.com/vrtmrz/obsidian-livesync.git synced 2026-10-21 16:52:32 +00:00
Code Issues Packages Projects Releases Wiki Activity

Document diagnostic actions in settings and issue reporting

Browse Source
This commit is contained in:
vorotamoroz
2026-10-19 18:22:23 +00:00
parent 7b43f8ca57
commit 7c59c9adbc
2 changed files with 12 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/settings.md
+8
View File
@@ -830,6 +830,14 @@ Select a file to copy its local database information. The command **Copy databas
The report includes the Vault-relative path, document and chunk identifiers, local database revisions, conflicts, and local chunk availability. It does not query the remote or include file contents. Paths and identifiers can still be private metadata, so review the report before sharing it.
#### Inspect database integrity
Select **Inspect** to choose original names or temporary pseudonyms and inspect normal-file Metadata and current conflicts locally and in CouchDB. The command **Inspect database integrity** opens the same dialogue. The inspection is read-only; its findings do not authorise deletion or perform repairs. See [Collect a report](troubleshooting.md#collect-a-report) for coverage, report formats, privacy, and cancellation.
#### Analyse database usage
Select **Analyse** to choose a name policy and report local revision and Chunk usage. The command **Analyse Database Usage (advanced)** opens the same dialogue when [advanced features](#enable-advanced-features) are enabled. Complete runs offer TSV and JSON; incomplete runs retain their status and reasons in JSON. Existing on-demand Chunk fetching stays unchanged. See [Collect a report](troubleshooting.md#collect-a-report) for accounting limits and export instructions.
#### Write logs into the file
Setting key: writeLogToTheFile
docs/to_issue_reporting.md
+4
View File
@@ -44,6 +44,10 @@ For a large report, you may share a GitHub Gist after reviewing and redacting it
## Additional evidence when relevant
### A problem involving database integrity or usage
Use **Hatch** → **Inspect database integrity** for database-wide consistency findings, or **Analyse database usage** for local revision and Chunk accounting. Follow [Collect a report](troubleshooting.md#collect-a-report) for the name choice, formats, and inspection limits. Temporary pseudonyms are the default; review the report before sharing it. Retain the status and reported reasons when sharing a partial or cancelled result.
### A problem involving one file
Run `Copy database information for the active file`, or use **Hatch** → **Copy database information for a file** to select another file.