Fixed broken documentation paths across four repositories
By RepoJournal , from @latent-9's public GitHub activity
Recoordinate spent the day correcting outdated and nonexistent file references in documentation across yonatangross/orchestkit, PaulRBerg/prb-contracts, vitejs/vite, and derailed/k9s.
In yonatangross/orchestkit, Recoordinate fixed SECURITY.md to point to the correct hooks documentation path [1]. The file had referenced `scripts/hooks/README.md`, which does not exist; the actual hooks README lives at `src/hooks/README.md`, and the same sentence already mentioned `src/hooks/`, so the path was corrected from `scripts` to `src`. Two releases followed in orchestkit: v9.5.3 and v9.5.4 [2][3], which included dependency updates and CI improvements.
In PaulRBerg/prb-contracts, Recoordinate merged a PR that fixed Contributing section links [4]. The documentation had pointed readers to the `prb-proxy` issue and discussion trackers instead of `prb-contracts` own trackers, appearing to be a copy-paste leftover from another repository [5]. Both links were updated to point to the correct repo.
Recoordinate also corrected documentation in vitejs/vite and derailed/k9s. The Vite environment API example imported a nonexistent `RemoteEnvironmentTransport` export [6][7], which would cause copy-pasted code to fail immediately. The k9s config example documented a `keepMissingClusters` setting that does not exist in the actual config struct and would fail schema validation [8][9].
One email a day. Unsubscribe in one click.
A short briefing every day latent-9 ships something — in about 3 minutes.
One email a day. Unsubscribe in one click. Read a past issue →
References
- [1] docs: fix nonexistent scripts/hooks path in SECURITY.md (#3248) yonatangross/orchestkit
- [2] v9.5.4 ↗ yonatangross/orchestkit
- [3] v9.5.3 ↗ yonatangross/orchestkit
- [4] Merge pull request #52 from latent-9/docs/fix-contributing-links PaulRBerg/prb-contracts
- [5] docs: point Contributing links to prb-contracts instead of prb-proxy ↗ PaulRBerg/prb-contracts
- [6] docs: remove nonexistent `RemoteEnvironmentTransport` import in environment API example (#23127) vitejs/vite
- [7] docs: remove nonexistent `RemoteEnvironmentTransport` import in environment API example ↗ vitejs/vite
- [8] docs: remove nonexistent keepMissingClusters option from config example (#4151) derailed/k9s
- [9] docs: remove nonexistent keepMissingClusters option from config example ↗ derailed/k9s