chore(docs): refresh docs/README counter and family list; extend sync-about scope#67
Open
kingchenc wants to merge 2 commits into
Open
chore(docs): refresh docs/README counter and family list; extend sync-about scope#67kingchenc wants to merge 2 commits into
kingchenc wants to merge 2 commits into
Conversation
…-about scope docs/README.md still advertised "71 indicators across the eight families" from the early Wickra catalogue. The Family-9 through Family-16 batches (market-profile, candlesticks, risk/performance, etc.) bumped the live count to 214 / sixteen families months ago, but this file was missed by the existing sync-about.yml workflow because that workflow only scanned README.md. Two changes: 1. **docs/README.md content**: "71 indicators" -> "214 indicators", "eight families" -> "sixteen families", expand the inline family list from 8 to all 16 (adds Bands & Channels, Ehlers / Cycle (DSP), Pivots & S/R, DeMark, Ichimoku & Charts, Candlestick Patterns, Market Profile, Risk / Performance). 2. **sync-about.yml**: the PR-flow now ALSO checks and patches docs/README.md alongside README.md. Same sed regex covers both files because docs/README's "**N indicators**" prose is matched by the existing `[0-9]+ (streaming-first )?indicators` pattern. The "Check counter" step explicitly verifies both files; the patch + git commit steps cover both; the fork-PR error message updated to mention both files. The wiki-sync part of the workflow is unchanged — docs/README.md is local to the main repo and does not appear in the wiki. Conflicts: this PR touches docs/README.md which PR #59 also touches (URL substitutions). #59 changes URLs on different lines than the counter / family-list text touched here, so the rebase after #59 lands should be clean.
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.
Summary
`docs/README.md` still advertised 71 indicators across the eight families from the early Wickra catalogue. The Family-9 through Family-16 batches (market profile, candlesticks, risk/performance, etc.) bumped the live count to 214 / sixteen families months ago, but this file was missed by the existing `sync-about.yml` workflow because the workflow only scanned `README.md`.
Changes
1. `docs/README.md` content
2. `.github/workflows/sync-about.yml`
The PR-flow now also checks and patches `docs/README.md` alongside `README.md`. The same sed regex covers both files because docs/README's `N indicators` prose matches the existing `[0-9]+ (streaming-first )?indicators` pattern. The Check counter step explicitly verifies both files; the patch + commit steps cover both; the fork-PR error message updated to mention both files.
Wiki-sync portion of the workflow is unchanged — `docs/README.md` is local to the main repo, not in the wiki.
Conflicts
This PR touches `docs/README.md` which PR #59 (org/email migration) also touches via URL substitutions. The two PRs touch different lines (URL strings vs counter / family-list prose), so the rebase after #59 lands should be clean.
CI expectation
29 standard checks. The sync-about job in particular will now also probe docs/README on this very PR — its own counter is already correct (214), so the check step will report matches=true and skip the patch path.