docs(wiki): correct stale example count (40+ → 70+)#330
Open
HanSur94 wants to merge 1 commit into
Open
Conversation
Architecture, Getting-Started, and Home each listed "40+ runnable examples", but examples/ now holds 82 runnable scripts. README (#209) was already corrected to "70+"; this aligns the wiki to match. Co-Authored-By: Claude Opus 4.8 <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
1 participant
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.
What drifted
Automated
/docs-passtriggered by two PRs merging intomainsince the last check: #212 (API usability polish) and #209 (README accuracy fixes).#209 corrected the README's facts, but three wiki prose pages still carried the old example count:
wiki/Architecture.md40+ runnable examples70+ runnable exampleswiki/Getting-Started.md40+ runnable examples70+ runnable exampleswiki/Home.md40+ runnable examples covering all library features70+ runnable examples covering all library featuresVerified against the tree:
examples/now holds 82 runnable.mscripts, so "70+" (matching the just-merged README) is accurate.What I checked but did NOT need to change
DerivedTag) — already documented inHome.mdandArchitecture.mdtag enumerations. No drift.API-Reference: Dashboardpage, whichscripts/generate_api_docs.pyowns). ConfirmedDashboardWidgetRegistry.seedBuiltins_registers exactly 19 canonical types.FastSense:unknownOptionwarning + clearer "Valid options" errors — no prose home exists; covered by docstrings/generated API reference.Out of scope (flagged for a maintainer to decide)
These are pre-existing and not introduced by #209/#212, so I left them out of this focused factual-drift PR:
fp→fsvariable convention. docs(readme): fix broken examples, correct counts, surface missing features #209 switched the README examples fromfptofs(the class isFastSense;fpis the legacy FastPlot mnemonic). ~108 occurrences remain across 6 wiki pages (Getting-Started,Datetime-Guide,Live-Mode-Guide,Performance,Home,Use-Case: Multi-Sensor-Shared-Threshold), includingfp1–fp4multi-instance variants. A clean rename is a large cosmetic diff better kept separate.FastPlot→FastSenseproduct-name debt still appears in wiki prose (e.g. theArchitecture.mdsource tree root, "set up FastPlot" inHome.md).functionSignatures.jsonforFastSense/DashboardEngine, added in API usability polish: clearer errors + editor tab-completion (5 additive fixes) #212) is a new user-facing capability not yet mentioned in any guide.Verification
wiki-links.yml(lychee) check is unaffected.🤖 Generated with Claude Code