Repository navigation
docs: fix accuracy defects across eslint rule and package reference pages - #207
Merged
Merged
Conversation
…ages Corrects 32 documentation pages found inaccurate by a full audit of all 94 published docs against their actual source: stale line citations, examples that don't trigger the rule they illustrate (or the reverse), a pervasive kind/unit schema-field error across two layer-boundary docs, stale .Type/.InputType signatures, false capability claims (Pino, hash/equal), missing hooks and exports, wrong validation-method citations, and a two-package gap in the package registry. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_014oGzg7BoLAKHRuVjbS8uuC
…k signatures onEnterState (StateMachine, EffectInterpreter) and onRegister (MachineRegistry) accept void | Promise<void>; the example's explicit void-only overrides understated what the base class permits. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_014oGzg7BoLAKHRuVjbS8uuC
Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_014oGzg7BoLAKHRuVjbS8uuC
eslint . walked into .enginseer/validation/snapshots/.../tree, a gitignored local validation-scratch tree enginseer's own hook writes, and crashed resolving a snapshot's relative import. Flat config ignores don't read .gitignore, so the gitignored directory still needed an explicit entry. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_014oGzg7BoLAKHRuVjbS8uuC
Contributor
Dependency Review✅ No vulnerabilities or license issues or OpenSSF Scorecard issues found.Scanned FilesNone |
Contributor
Dependency Blast RadiusBase ref: Touched packages: @studnicky/fsm Impacted packages: @studnicky/cache, @studnicky/concurrency, @studnicky/context, @studnicky/drilldown, @studnicky/event-bus, @studnicky/filters, @studnicky/fsm, @studnicky/matching, @studnicky/paginator, @studnicky/resilience, @studnicky/scheduler, @studnicky/store, @studnicky/system Package test signal: 13/13 impacted package(s) have package tests flowchart LR
classDef modified fill:#fff3cd,stroke:#856404,color:#664d03
classDef impacted_1 fill:#e28c36,stroke:#ad661f,color:#000000
classDef impacted_2 fill:#e2a363,stroke:#ad661f,color:#000000
classDef impacted_3 fill:#eacfb4,stroke:#ad661f,color:#000000
classDef impacted_4 fill:#f2e6d9,stroke:#ad661f,color:#000000
p__studnicky_cache["@studnicky/cache"]
p__studnicky_concurrency["@studnicky/concurrency"]
p__studnicky_context["@studnicky/context"]
p__studnicky_drilldown["@studnicky/drilldown"]
p__studnicky_event_bus["@studnicky/event-bus"]
p__studnicky_filters["@studnicky/filters"]
p__studnicky_fsm["@studnicky/fsm"]
p__studnicky_matching["@studnicky/matching"]
p__studnicky_paginator["@studnicky/paginator"]
p__studnicky_resilience["@studnicky/resilience"]
p__studnicky_scheduler["@studnicky/scheduler"]
p__studnicky_store["@studnicky/store"]
p__studnicky_system["@studnicky/system"]
p__studnicky_cache --> p__studnicky_concurrency
p__studnicky_concurrency --> p__studnicky_fsm
p__studnicky_concurrency --> p__studnicky_scheduler
p__studnicky_context --> p__studnicky_fsm
p__studnicky_drilldown --> p__studnicky_cache
p__studnicky_drilldown --> p__studnicky_filters
p__studnicky_event_bus --> p__studnicky_concurrency
p__studnicky_filters --> p__studnicky_matching
p__studnicky_matching --> p__studnicky_cache
p__studnicky_paginator --> p__studnicky_fsm
p__studnicky_resilience --> p__studnicky_cache
p__studnicky_resilience --> p__studnicky_fsm
p__studnicky_resilience --> p__studnicky_scheduler
p__studnicky_scheduler --> p__studnicky_fsm
p__studnicky_store --> p__studnicky_concurrency
p__studnicky_system --> p__studnicky_fsm
class p__studnicky_cache impacted_2
class p__studnicky_concurrency impacted_1
class p__studnicky_context impacted_1
class p__studnicky_drilldown impacted_3
class p__studnicky_event_bus impacted_2
class p__studnicky_filters impacted_4
class p__studnicky_fsm modified
class p__studnicky_matching impacted_3
class p__studnicky_paginator impacted_1
class p__studnicky_resilience impacted_1
class p__studnicky_scheduler impacted_1
class p__studnicky_store impacted_2
class p__studnicky_system impacted_1
subgraph Legend
legend_modified["Package contains modified files"]:::modified
legend_impacted_1["Impacted 1 hop away"]:::impacted_1
legend_impacted_2["Impacted 2 hops away"]:::impacted_2
legend_impacted_3["Impacted 3 hops away"]:::impacted_3
legend_impacted_4["Impacted 4 hops away"]:::impacted_4
end
|
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.
What
Fixes 32 documentation pages found inaccurate by a full audit of all 94 published docs against their actual source, and excludes a gitignored local validation-scratch directory from the eslint flat config that was crashing lint.
Files: +4 ~33
Why
The published docs had drifted from source: stale line citations, examples that don't trigger the rule they illustrate (or the reverse), a pervasive
kind/unitschema-field error across two layer-boundary docs, stale.Type/.InputTypesignatures, false capability claims (Pino, hash/equal), missing hooks and exports, wrong validation-method citations, and a two-package gap in the package registry. Separately,eslint.config.tslacked an ignore for.enginseer/(gitignored but still walked byeslint .), which crashed the pre-push lint on an unresolvable snapshot import.Testing
Risks
Low — documentation-only content changes, one additive eslint ignore entry, and one example file's override return type widened to match its (already valid, unchanged) base class signature.
Links
Checklist
A doc that drifts from source is a loan against every reader's trust — this pays down 32 lines of principal before the interest compounds further.
🤖 Generated with Claude Code
https://claude.ai/code/session_014oGzg7BoLAKHRuVjbS8uuC