Skip to content

Docs: link liblsl-specific content instead of repeating it - #147

Merged
cboulay merged 1 commit into
masterfrom
docs/link-liblsl
Oct 14, 2026
Merged

cboulay merged 1 commit into
masterfrom
docs/link-liblsl

Conversation

@cboulay

@cboulay cboulay commented Oct 14, 2026

Copy link
Copy Markdown
Collaborator

Follow-up to #145: pages that still repeated liblsl's documentation now summarize and link to it.

  • Time Synchronization: keeps the practical guidance (record with LabRecorder and synchronize at import, what the XDF importers do, online options, non-LSL clocks, header parameters, validation). The measurement theory (offset estimation, bias, mapping, dejitter tuning) moved to liblsl's Time synchronization page in docs: time sync accuracy, offset mapping and dejitter tuning liblsl#336; merge that first.
  • Getting LSL: the liblsl section is now a two-paragraph summary (with the package-manager lag caveat) linking to Getting liblsl, instead of repeating its list.
  • User's Guide: a short overview of discovery, data, clock offsets and recovery replaces an outdated copy of liblsl's internals, linking to How liblsl works.
  • Examples: C/C++ link to liblsl's examples/ and its README (which has the same walkthrough).
  • FAQs: High sampling rates mentions the synchronous outlet mode (1.18) instead of the old PR #170; Binaries uses current release file names. Its two warnings were silently hidden (.. warning without ::), now shown.
  • Documentation Syntax → Contributing to the documentation: where each part of the docs lives (this repo: reStructuredText; liblsl: MyST Markdown + Mermaid), how to build both, and the :liblsl: role.

No new Sphinx warnings compared with master.

- Time Synchronization keeps the practical guidance (synchronize at
  import with LabRecorder and the XDF importers, online options, non-LSL
  clocks, header parameters, validation). The measurement theory moved to
  liblsl's time synchronization page (sccn/liblsl#336). Fixes a link to
  an old commit of inlet.h.
- Getting LSL: the liblsl section is a short summary with the lag caveat,
  linking to Getting liblsl instead of repeating its list.
- User's Guide: a short overview of discovery, data, clock offsets and
  recovery, instead of an outdated copy of liblsl's internals.
- Examples: link to liblsl's examples folder and README for C/C++.
- FAQs: high data rates mention the synchronous outlet mode (1.18)
  instead of a 2022 pull request; current release file names; the two
  Binaries warnings were comments (missing ::) and are now shown.
- Documentation Syntax becomes Contributing to the documentation: where
  each part of the docs lives, how to build both, the :liblsl: role.
@cboulay
cboulay merged commit 4e15419 into master Oct 14, 2026
1 check passed
@cboulay
cboulay deleted the docs/link-liblsl branch October 14, 2026 20:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant