feat: docs 335 review dependencies on documentation site#413
feat: docs 335 review dependencies on documentation site#413niallobrien wants to merge 5 commits into
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
There was a problem hiding this comment.
Pull request overview
Modernizes the Cloudsmith docs site toolchain and runtime (Next.js/React/TypeScript/etc.), updates lint/build configuration to match the new stack, and applies targeted UI/component refactors (notably video embeds and API Sandbox inputs) to preserve behavior after the upgrades.
Changes:
- Upgrade core framework/tooling dependencies (Next.js 16, React 19, TypeScript 6, Jest/Stylelint/Shiki, etc.) and refresh project configs.
- Migrate JS linting to ESLint CLI flat config; update Stylelint/Prettier/PostCSS configs for the upgraded toolchain.
- Refactor key UI surfaces (Video embed flow, API Sandbox request body/param inputs) and normalize a number of CSS module styles.
Reviewed changes
Copilot reviewed 23 out of 25 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| tsconfig.json | Updates TS target/module resolution/JSX settings and include/types to match newer Next/TS toolchain. |
| stylelint.config.mjs | Adjusts Stylelint rules for upgraded Stylelint + legacy styling tolerance. |
| src/icons/svgs/integration/CursorIDE.tsx | SVG formatting/attribute normalization for the Cursor IDE integration icon. |
| src/components/WithQuickNav/WithQuicknav.module.css | Minor whitespace/formatting normalization. |
| src/components/Video/Video.tsx | Reworks video playback to use a Wistia iframe + overlay click-to-autoplay flow. |
| src/components/Video/Video.module.css | Adds iframe sizing/border reset and poster overlay background support. |
| src/components/Tag/Tag.module.css | Simplifies padding declaration. |
| src/components/Sidenav/Sidenav.module.css | Minor whitespace/formatting normalization. |
| src/components/SearchDialog/SearchTrigger/SearchTrigger.module.css | Removes redundant border reset (keeps explicit border). |
| src/components/Note/Note.module.css | Normalizes color syntax and margin shorthand. |
| src/components/Navbar/Navbar.module.css | Uses inset shorthand for fixed mobile overlay/navbar layout. |
| src/components/HomepageHero/HomepageHero.module.css | Token/value normalization and minor gradient text styling changes. |
| src/components/CodeBlock/CodeBlock.module.css | Normalizes color syntax and minor spacing formatting. |
| src/components/BackgroundGrid/BackgroundGrid.module.css | Minor whitespace/formatting normalization. |
| src/components/ApiSandbox/SandboxInput/components/RequestBody/RequestBody.tsx | Simplifies nested vs non-nested rendering flow for object body params. |
| src/components/ApiSandbox/SandboxInput/components/ParamSet/inputs/ParamInput.tsx | Switches debounced handler memoization approach for param input changes. |
| src/app/layout.tsx | Adds an ESLint disable comment for a deliberate <img> usage in <noscript>. |
| src/app/_styles/variables.css | Normalizes CSS color syntax and comment spacing. |
| README.md | Updates contributor/local dev docs and adds “latest branch changes” notes. |
| prettier.config.js | Refactors to a named config constant for consistency with other config modules. |
| postcss.config.js | Refactors to a named config constant for consistency with other config modules. |
| package.json | Dependency and script updates (ESLint flat config, major version upgrades). |
| next.config.mjs | Updates Turbopack configuration keying for newer Next.js. |
| eslint.config.mjs | Adds ESLint flat config aligned with Next.js + Prettier. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
aptkingston
left a comment
There was a problem hiding this comment.
LGTM. Manually verified a few pages with each type of change and everything still works as intended - couldn't find any regressions. Nice work 👍
Summary
This branch modernises the documentation site stack, resolves compatibility issues introduced by dependency upgrades, and applies targeted UI/component refactors to preserve behavior across docs pages.
Highest-risk areas to validate:
Manual QA plan (localhost:3000 - all manually tested)
npm test- all tests pass'npm run schemas:download
- API schemas download correctly.Loaded schema: api-schema-v1.json (version: v1),Loaded schema: api-schema-v2.json (version: v2)npm run build` - build successfulHigh-priority video pages:
Additional video coverage:
Other key surfaces: