Skip to content

docs: use images instead of ascii for network use cases#805

Open
jnfrati wants to merge 3 commits into
mainfrom
docs/use-images-for-network-use-cases
Open

docs: use images instead of ascii for network use cases#805
jnfrati wants to merge 3 commits into
mainfrom
docs/use-images-for-network-use-cases

Conversation

@jnfrati

@jnfrati jnfrati commented Jun 19, 2026

Copy link
Copy Markdown
Contributor

Summary

Replaces the static ASCII architecture diagrams in the Networks use-case docs with the new architecture images.

Changes

  • Updated six Networks use-case pages to use architecture.png diagrams:
    • access-home-devices.mdx
    • active-directory.mdx
    • cloud-to-on-premise.mdx
    • reach-services-on-the-routing-peer.mdx
    • site-to-site.mdx
    • site-to-vpn.mdx
  • Added descriptive alt text for each architecture image.
  • Removed the corresponding ASCII diagram blocks.

Summary by CodeRabbit

  • Documentation
    • Updated network configuration guides with improved architecture diagrams across six use-case scenarios, including home device access, Active Directory integration, cloud-to-on-premise connectivity, routing peers, site-to-site, and site-to-VPN configurations.

@coderabbitai

coderabbitai Bot commented Jun 19, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

Important

Review skipped

Review was skipped due to path filters

⛔ Files ignored due to path filters (5)
  • public/docs-static/img/manage/networks/use-cases/access-home-devices/architecture.png is excluded by !**/*.png
  • public/docs-static/img/manage/networks/use-cases/active-directory/architecture.png is excluded by !**/*.png
  • public/docs-static/img/manage/networks/use-cases/cloud-to-on-premise/architecture.png is excluded by !**/*.png
  • public/docs-static/img/manage/networks/use-cases/site-to-site/architecture.png is excluded by !**/*.png
  • public/docs-static/img/manage/networks/use-cases/site-to-vpn/architecture.png is excluded by !**/*.png

CodeRabbit blocks several paths by default. You can override this behavior by explicitly including those paths in the path filters. For example, including **/dist/** will override the default block on the dist directory, by removing the pattern from both the lists.

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 89a22f97-b4d1-420d-b692-1ffe7c40cca9

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review
📝 Walkthrough

Walkthrough

Six use-case MDX documentation pages under src/pages/manage/networks/use-cases/ replace ASCII/text architecture diagrams with rendered architecture.png images. Each change substitutes the previous fenced code block or inline text diagram with an <img> element inside a <p> tag, using consistent alt text and imagewrapper className.

Changes

Architecture Diagram Replacement in Use-Case Docs

Layer / File(s) Summary
ASCII diagrams replaced with architecture images
src/pages/manage/networks/use-cases/site-to-site.mdx, src/pages/manage/networks/use-cases/access-home-devices.mdx, src/pages/manage/networks/use-cases/active-directory.mdx, src/pages/manage/networks/use-cases/cloud-to-on-premise.mdx, src/pages/manage/networks/use-cases/reach-services-on-the-routing-peer.mdx, src/pages/manage/networks/use-cases/site-to-vpn.mdx
Each page's ASCII/fenced-code architecture diagram is removed and replaced with an <img> element pointing to architecture.png (per-use-case path) wrapped in a <p> tag, with alt text and className="imagewrapper".

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

  • netbirdio/docs#773: Originally added the site-to-site.mdx use-case guide whose "Architecture" section this PR updates from ASCII to image.
  • netbirdio/docs#796: Added active-directory.mdx and reach-services-on-the-routing-peer.mdx pages whose diagrams are replaced in this PR.
  • netbirdio/docs#797: Edited site-to-site.mdx's "Architecture" note text, overlapping the same section updated here.

Suggested reviewers

  • SunsetDrifter

Poem

🐇 No more ASCII art, all squiggly and rough,
Real pictures of networks — now isn't that enough?
A .png here, a .png there,
Tunnels and peers drawn with actual flair.
The diagrams hop in, neat and precise,
This bunny thinks images are ever so nice! 🖼️

🚥 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 directly and accurately summarizes the main change: replacing ASCII diagrams with images across multiple network use-case documentation files.
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.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/use-images-for-network-use-cases

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant