Repository navigation
docs: bring agent instructions and guides in line with the 1.0.0 SDK - #243
Merged
Merged
Conversation
An audit of every CLAUDE.md, skill and guide against the code found stale claims, samples that do not compile, and history mixed into current docs. - Root CLAUDE.md: read path for plugin authors and ABI changes, correct changelog heading, five floor-surface kinds, real warning flags, CI-only gates; release mechanics move to the new docs/RELEASING.md. - plotjuggler-plugin skill: five families with a new Widget reference, correct toolbox threading, onDataChanged is advisory, closed encoding list, plugin_host for loader tests, null handling, 1.0 pin guidance. - pj_plugins guides: fix non-compiling samples, document readSeries and nulls, resolve the parser-bridge contradiction, consumer CMake targets, remove PR and pre-v4 history. - Reference docs: drop a nonexistent host API from the dialog reference, add missing setters/handlers and utilities, current marker producers, BACKLOG cut to open items, V4_STORE.md -> docs/object_store.md with the correct service id; the historical toolbox gap analysis goes to docs/archive/. - C++ style docs: no tsl::robin_map (not a dependency), real flags. - Header comments: Log `source`, `timestamp_ns` field names. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Why
Agents working in this repo (and plugin authors using the
plotjuggler-pluginskill) were reading instructions that no longer match the code: four plugin families instead of five, a wrong toolbox threading rule, samples that do not compile, a host API that does not exist, a hash-map library the SDK does not depend on, and plan/history text mixed into current docs.Four read-only audits checked every
CLAUDE.md, skill and guide claim against the headers, CMake and the## [1.0.0] — Unreleasedchangelog. Each finding was verified against the code before it was edited.What changed
Entry points
CLAUDE.md: a read path for each kind of task (writing a plugin, changing the SDK, changing ABI), the correct changelog heading, all five floor-surface kinds, the real warning flags, how to run a test subset, and the two gates only CI runs (ABI drift, WASI). The 68 lines of release mechanics move to a newdocs/RELEASING.md; the root keeps the bump table and the rules an agent must not miss.CLAUDE.mdfiles:libraryOwner()exists only onDataSourceHandle; the widget guide is linked;plugin_hostis named; duplicated layering text removed; the dialog-protocol file keeps one line per trap and links the guide for the details.test-and-commit: clang-tidy points atbuild/debug_asan(the folder./build.sh --debugcreates); layout and components listed.plotjuggler-plugin skill
references/widget.md.onDataChangedis advisory.registeredParserEncodings());PJ::ParserBindingRequest(was a non-compilingPJ::sdk::name); config guard for an empty config;max_size == 0means unlimited.plugin_hostfor loader tests,PJ_BUILD_TESTS=OFFwhen vendoring,_NAMEDmacros, nulls on write and read, typedregisterObjectTopic, GridMap/MeshMap, 1.0 pin guidance.pj_plugins guides (18 confirmed defects): non-compiling samples,
readSeries()and null handling, the removed colormap service, the parser C++ bridge contradiction,bindSchema()override must call the base, consumer CMake targets withpj_configure_plugin, runtime-host thread tags, and PR/pre-v4 history removed.Reference docs: the dialog reference loses a nonexistent host API and gains the missing setters/handlers; plot markers describe the shipped producers;
sdk-utilities.mdlists the missing helpers;BACKLOG.mdkeeps only open items;V4_STORE.md→docs/object_store.mdwith the correctpj.toolbox_write.v1id; the historical toolbox gap analysis moves todocs/archive/;cpp_design_recommendations.mddropstsl::robin_mapand the invented flag list.Code: comment-only changes in four builtin headers (
Log::source,timestamp_ns) and one workflow comment. No version bump.Not changed
packaging/conan-center-index/is still seeded at 0.16.2 and lacks thesourcecomponent;docs/RELEASING.mdnow says it is outside the build. Whether to update or delete it is a separate decision.install_qt6.shand the Qt hint inbuild.sh(nothing uses Qt), thepj_ported_plugins/handling inbuild.shandCMakeLists.txt, and the unknown-DPJ_BUILD_PARQUET_IMPORT_EXAMPLEintest_sdk_install.sh.Checks
pre-commit run --all-filespasses..mdexcept CHANGELOG anddocs/archive/).🤖 Generated with Claude Code