docs: make single sources of truth authoritative for remaining duplicated values - #164
Merged
Merged
Conversation
…ated values
Complete the documentation SSOT cleanup: the plugin catalogue's totals
and per-status counts were already consolidated into doc/PLUGINS.md
section 6, but several other current-derived values were still
duplicated across README and the docs.
- Point runtime dependency counts (README, DEPLOYMENT.md) at
automatic.gemspec instead of restating "four pure-Ruby gems".
- Point the continuously validated Ruby set (README, DEPLOYMENT.md,
REQUIREMENTS.md, RELEASING.md, CI comments) at the matrix in
.github/workflows/ci.yml instead of repeating "3.3, 3.4 and 4.0".
- Drop the framework's duplicated line-count claim in favor of
BASIC_DESIGN.md/POLICY.md as the maintained responsibility boundary.
- Replace the bundled siteinfo snapshot's stale "newest entries are
from 2013" narrative (doc/PLUGINS.md and full_feed.rb comments) with
behavior that doesn't depend on the snapshot's age, matching the
v26.09 refresh from a newer upstream snapshot.
- Replace hardcoded current AI model names in PLUGINS.md and
AI_TUTORIAL.md examples with placeholders, since model availability
is service-owned.
- Resolve the QUICKSTART.md "two optional gems" vs. the three gems its
own install steps actually use, by deriving the count from the
DEPLOYMENT.md dependency table instead of stating it twice.
- Update AI_TUTORIAL.md's "no chunking plugin" claim to reflect the
new FilterLimit/FilterBatch plugins added in v26.09.
- Remove the Status column from DEPLOYMENT.md's optional-dependency
table, leaving PLUGINS.md section 6 as the single source for support
status.
- Replace remaining small-count prose ("two conventions", "three ways
to set one up", step-number cross-references, etc.) with references
to the actual section/table rather than a number that drifts.
- Shorten two doc/VERSIONS v26.09 bullets that exceeded this file's own
line-length guideline, without changing their content.
Gemfile, automatic.gemspec, and the GitHub Actions workflow files
receive comment-only changes; no executable Ruby, YAML, or dependency
declaration changed. plugins/filter/full_feed.rb also receives
comment-only changes. spec/doc/plugins_catalogue_spec.rb, VERSION,
lib/, assets/, config/, spec/, test/, and Rakefile are untouched.
bundle exec rspec spec/doc/plugins_catalogue_spec.rb and bundle exec
rake spec both pass (357 examples, 0 failures).
5 tasks
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.
Summary
The plugin catalogue's totals and per-status counts were already consolidated into
doc/PLUGINS.mdsection 6 in a prior change, but several other current-derived values were still duplicated across README and the docs. This finishes that cleanup.automatic.gemspecinstead of restating "four pure-Ruby gems"..github/workflows/ci.ymlinstead of repeating "3.3, 3.4 and 4.0".BASIC_DESIGN.md/POLICY.mdas the maintained responsibility boundary.doc/PLUGINS.mdandfull_feed.rbcomments) with behavior that doesn't depend on the snapshot's age, matching the v26.09 refresh from a newer upstream snapshot.PLUGINS.mdandAI_TUTORIAL.mdexamples with placeholders, since model availability is service-owned.Gemfile, automatic.gemspec, and the GitHub Actions workflow files receive comment-only changes; no executable Ruby, YAML, or dependency declaration changed.
plugins/filter/full_feed.rbalso receives comment-only changes.spec/doc/plugins_catalogue_spec.rb,VERSION,lib/,assets/,config/,spec/,test/, andRakefileare untouched.Test plan
bundle exec rspec spec/doc/plugins_catalogue_spec.rb— 4 examples, 0 failures, no diff to this filebundle exec rake spec— 357 examples, 0 failuresgit diff --check— cleanGenerated by Claude Code