docs(site): fix codemods file layout and add registered codemods table#694
Merged
jamesadevine merged 1 commit intoMay 22, 2026
Merged
Conversation
- Replace the three fabricated example filenames (0001_engine_id_split.rs, 0002_permissions_field.rs, 0003_safeoutput_renames.rs) in the File layout section with the actual files in src/compile/codemods/ with their real comments. - Add a 'Registered codemods' table near the top listing the two live codemods (repos_unified, pool_object_form) with their IDs, summaries, and introduced-in versions, verified against src/compile/codemods/*.rs. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Open
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
Changes
site/src/content/docs/reference/codemods.mdx:0001_engine_id_split.rs,0002_permissions_field.rs,0003_safeoutput_renames.rs) with the actual files (0001_repos_unified.rs,0002_pool_object_form.rs) and their real inline comments.introduced_inversion.Accuracy checks
src/compile/codemods/directory listing: exactlymod.rs,helpers.rs,0001_repos_unified.rs,0002_pool_object_form.rs.0001_repos_unified::CODEMOD:id = "repos_unified",summary = "repositories: + checkout: -> unified repos:",introduced_in = "0.28.0".0002_pool_object_form::CODEMOD:id = "pool_object_form",summary = "pool: <string> -> pool object form (name/vmImage)",introduced_in = "0.30.0"(INTRODUCED_INconst).mod.rsregistry:CODEMODS = [&m0001_repos_unified::CODEMOD, &m0002_pool_object_form::CODEMOD].Validation
cd site && npm ci && npm run build— 29 pages built, all internal links valid.Created by the docs-writer workflow.