Fix reference sync, slugs, and linting issues (CX-3425)#13
Open
jesseyowell wants to merge 16 commits into
Open
Fix reference sync, slugs, and linting issues (CX-3425)#13jesseyowell wants to merge 16 commits into
jesseyowell wants to merge 16 commits into
Conversation
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
…check Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
The reference title/excerpt update path was removed in CX-3425, leaving changes.updated permanently empty. Remove it from the changes object, the syncOas JSDoc, and the oas:sync run() summary. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
…pass Replace the two-pass design (files-derived 'missing from order' + a second filesystem walk for stale entries) with one walk per content dir that diffs the on-disk slug set against the _order.yaml entries: missing = onDisk - ordered, stale = ordered - onDisk. Removes findOrderFiles, entryExists, and the dirContents/seenOrderFiles bookkeeping. Behavior unchanged; adds a test that a folder entry with no markdown children is not flagged stale. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
…i-issues-around-reference-sync-slugs-and-linting # Conflicts: # src/validators/numbering.js
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.
Fixes the follow-up issues from CX-3425.
What changed
oas:syncno longer writes or updatestitle/excerpton api-backed reference pages (generated pages carry onlyapi.file+api.operationId); the frontmatter linter no longer requirestitleon reference pages that declareapi.file; and thetitle/excerpt"out of sync" checks were removed. This clears themust have required property 'title'andOut of sync: title…/excerpt…false positives. Existingtitle/excerptare left untouched (non-destructive).docs/andreference/is no longer flagged.custom_blocks/(e.g.<ClosedBeta>global/Enterprise blocks) are now warnings, not errors, so they don't fail CI._order.yamlentries flagged. Entries listed in_order.yamlwith no matching file/folder — andindexentries — are now flagged (warning) and removable with--fix, acrossdocs/,reference/,recipes/, andcustom_pages/. (Implemented as a single per-directory pass that diffs the on-disk slug set against the_order.yamlentries.)(Dropped: item 2, the
-1renamer/redirects — see the update note above.)Tests
Adds a
node:testsuite undertest/(the repo previously had none): 17 tests, all passing (npm test). Covers each changed validator plus edge cases (cross-section duplicates allowed, unknown component is a warning,--fixadd/remove paths, a folder entry with no markdown children is not flagged stale).End-to-end verification
Ran
linton the Lightcast reference project (~1,111 reference pages) withmainvs. this branch:frontmatterrequired-titleerrorsoas-reference"Out of sync" title/excerptduplicatescross-section false positivesorderingstale_order.yamlentries~1,050 false-positive findings eliminated on reference content that OAS now owns. The 10 remaining errors are 1 real within-
reference/duplicate + 9 real broken links — genuine pre-existing issues, not regressions, solintstill correctly exits 1. Verification was read-only; no--fixagainst the cloned data.Notes
docs:commits are the design spec and implementation plan underdocs/superpowers/— planning artifacts, not product code.0.0.29.main(which removed thenumbering.jsvalidator).🤖 Generated with Claude Code