Skip to content

chore: update main flow gif and image references for docs#523

Merged
skevetter merged 1 commit into
mainfrom
chore/update-docs
Jun 24, 2026
Merged

chore: update main flow gif and image references for docs#523
skevetter merged 1 commit into
mainfrom
chore/update-docs

Conversation

@skevetter

@skevetter skevetter commented Jun 24, 2026

Copy link
Copy Markdown
Contributor

Signed-off-by: Samuel K skevetter@pm.me

Summary by CodeRabbit

  • Documentation
    • Refreshed the docs and README with updated branding and messaging.
    • Simplified several quickstart and tutorial pages by removing redundant screenshots and making steps more text-first.
    • Clarified key workflows, including workspace creation, updates, browser-based VS Code access, SSH connection, JetBrains setup, and Docker-on-WSL configuration.
    • Updated page titles and introductory copy to better describe engineering-at-scale workflows.

Signed-off-by: Samuel K <skevetter@pm.me>
@netlify

netlify Bot commented Jun 24, 2026

Copy link
Copy Markdown

Deploy Preview for devsydev ready!

Name Link
🔨 Latest commit 6917630
🔍 Latest deploy log https://app.netlify.com/projects/devsydev/deploys/6a3bab66edd709000826076a
😎 Deploy Preview https://deploy-preview-523--devsydev.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@coderabbitai

coderabbitai Bot commented Jun 24, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: d34a3d17-ab23-45bf-934c-30440b27d6e7

📥 Commits

Reviewing files that changed from the base of the PR and between 1bacaf9 and 6917630.

⛔ Files ignored due to path filters (30)
  • sites/docs-devsy-sh/static/media/add-provider-1.png is excluded by !**/*.png
  • sites/docs-devsy-sh/static/media/add-provider-2.png is excluded by !**/*.png
  • sites/docs-devsy-sh/static/media/create-workspace-final-jetbrains.png is excluded by !**/*.png
  • sites/docs-devsy-sh/static/media/create-workspace-final-ssh.png is excluded by !**/*.png
  • sites/docs-devsy-sh/static/media/create-workspace-final-vim.png is excluded by !**/*.png
  • sites/docs-devsy-sh/static/media/create-workspace-final-vscode-browser.png is excluded by !**/*.png
  • sites/docs-devsy-sh/static/media/create-workspace-final-vscode.png is excluded by !**/*.png
  • sites/docs-devsy-sh/static/media/create-workspace-jetbrains-2.png is excluded by !**/*.png
  • sites/docs-devsy-sh/static/media/create-workspace-jetbrains-3.png is excluded by !**/*.png
  • sites/docs-devsy-sh/static/media/create-workspace-jetbrains.png is excluded by !**/*.png
  • sites/docs-devsy-sh/static/media/create-workspace-repo.png is excluded by !**/*.png
  • sites/docs-devsy-sh/static/media/create-workspace-ssh.png is excluded by !**/*.png
  • sites/docs-devsy-sh/static/media/create-workspace-vim.png is excluded by !**/*.png
  • sites/docs-devsy-sh/static/media/create-workspace-virtualbox-install-ubuntu.png is excluded by !**/*.png
  • sites/docs-devsy-sh/static/media/create-workspace-virtualbox-k8s-provider-success.png is excluded by !**/*.png
  • sites/docs-devsy-sh/static/media/create-workspace-virtualbox-kubernetes-provider-configuration.png is excluded by !**/*.png
  • sites/docs-devsy-sh/static/media/create-workspace-virtualbox-start-vm.png is excluded by !**/*.png
  • sites/docs-devsy-sh/static/media/create-workspace-virtualbox-workspace-create.png is excluded by !**/*.png
  • sites/docs-devsy-sh/static/media/create-workspace-virtualbox-workspace.png is excluded by !**/*.png
  • sites/docs-devsy-sh/static/media/create-workspace-vscode-2.png is excluded by !**/*.png
  • sites/docs-devsy-sh/static/media/create-workspace-vscode-browser-2.png is excluded by !**/*.png
  • sites/docs-devsy-sh/static/media/create-workspace-vscode-browser.png is excluded by !**/*.png
  • sites/docs-devsy-sh/static/media/create-workspace-vscode.png is excluded by !**/*.png
  • sites/docs-devsy-sh/static/media/devsy-architecture-2.png is excluded by !**/*.png
  • sites/docs-devsy-sh/static/media/devsy-architecture.svg is excluded by !**/*.svg
  • sites/docs-devsy-sh/static/media/devsy-dark.png is excluded by !**/*.png
  • sites/docs-devsy-sh/static/media/devsy-flow.gif is excluded by !**/*.gif
  • sites/docs-devsy-sh/static/media/devsy-update-available.png is excluded by !**/*.png
  • sites/docs-devsy-sh/static/media/devsy-update-done.png is excluded by !**/*.png
  • sites/docs-devsy-sh/static/media/docker-provider-via-wsl.png is excluded by !**/*.png
📒 Files selected for processing (12)
  • README.md
  • sites/docs-devsy-sh/docusaurus.config.js
  • sites/docs-devsy-sh/pages/fragments/virtualbox-ubuntu-22.04.mdx
  • sites/docs-devsy-sh/pages/getting-started/update.mdx
  • sites/docs-devsy-sh/pages/quickstart/browser.mdx
  • sites/docs-devsy-sh/pages/quickstart/jetbrains.mdx
  • sites/docs-devsy-sh/pages/quickstart/ssh.mdx
  • sites/docs-devsy-sh/pages/quickstart/vim.mdx
  • sites/docs-devsy-sh/pages/quickstart/vscode.mdx
  • sites/docs-devsy-sh/pages/tutorials/docker-provider-via-wsl.mdx
  • sites/docs-devsy-sh/pages/tutorials/minikube-vscode-browser.mdx
  • sites/docs-devsy-sh/pages/what-is-devsy.mdx
💤 Files with no reviewable changes (10)
  • sites/docs-devsy-sh/pages/getting-started/update.mdx
  • sites/docs-devsy-sh/pages/quickstart/browser.mdx
  • sites/docs-devsy-sh/pages/quickstart/vscode.mdx
  • sites/docs-devsy-sh/pages/quickstart/jetbrains.mdx
  • sites/docs-devsy-sh/pages/what-is-devsy.mdx
  • sites/docs-devsy-sh/pages/quickstart/vim.mdx
  • sites/docs-devsy-sh/pages/fragments/virtualbox-ubuntu-22.04.mdx
  • sites/docs-devsy-sh/pages/tutorials/docker-provider-via-wsl.mdx
  • sites/docs-devsy-sh/pages/quickstart/ssh.mdx
  • sites/docs-devsy-sh/pages/tutorials/minikube-vscode-browser.mdx

📝 Walkthrough

Walkthrough

Updates README hero copy (logo path fix, description text, section heading rename) and Docusaurus site title/tagline to "Engineering at scale". Removes embedded screenshot <figure> blocks from multiple documentation pages (quickstart, tutorials, getting-started, what-is-devsy), replacing visuals with inline text descriptions or omitting them entirely.

Changes

Docs & README Branding Refresh

Layer / File(s) Summary
README and Docusaurus branding copy
README.md, sites/docs-devsy-sh/docusaurus.config.js
Dark-mode logo srcset filename corrected (devsy_dark.pngdevsy-dark.png), hero description text replaced, "Operate Engineering at Scale" heading renamed to "Engineering at Scale", and Docusaurus title/tagline updated to "Engineering at scale".
Screenshot figure removal across docs
sites/docs-devsy-sh/pages/what-is-devsy.mdx, sites/docs-devsy-sh/pages/getting-started/update.mdx, sites/docs-devsy-sh/pages/quickstart/*.mdx, sites/docs-devsy-sh/pages/tutorials/docker-provider-via-wsl.mdx, sites/docs-devsy-sh/pages/tutorials/minikube-vscode-browser.mdx, sites/docs-devsy-sh/pages/fragments/virtualbox-ubuntu-22.04.mdx
Embedded <figure> screenshot blocks removed from the architecture overview, update flow, all quickstart guides (browser, VS Code, JetBrains, SSH, Vim), and tutorial walkthroughs (Docker/WSL, Minikube, VirtualBox), with inline text substituted where needed.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

  • devsy-org/devsy#510: Overlaps directly with this PR by editing README.md marketing copy and sites/docs-devsy-sh/pages/getting-started/update.mdx Desktop update and restart instructions.
🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title matches the docs-focused updates to image references and related content across the documentation site.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@netlify

netlify Bot commented Jun 24, 2026

Copy link
Copy Markdown

Deploy Preview for images-devsy-sh canceled.

Name Link
🔨 Latest commit 6917630
🔍 Latest deploy log https://app.netlify.com/projects/images-devsy-sh/deploys/6a3bab66f081980007f96f92

@skevetter
skevetter marked this pull request as ready for review June 24, 2026 10:13
@skevetter
skevetter merged commit 5f33047 into main Jun 24, 2026
20 checks passed
@skevetter
skevetter deleted the chore/update-docs branch June 24, 2026 10:16
@coderabbitai coderabbitai Bot mentioned this pull request Jul 24, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant