Skip to content

DOCS-4129: Remove "Establish a connection" sections from API pages #4422

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

promptless[bot]
Copy link
Contributor

@promptless promptless bot commented Jun 28, 2025

Remove the "Establish a connection" sections from all API reference pages in /dev/reference/apis/ directory as requested by the user. These sections contain SDK connection setup, import statements, and basic configuration examples that are redundant with the CONNECT tab functionality and clutter the API reference documentation.

The sections to be removed typically include:

  • Connection setup instructions referring to the CONNECT tab
  • SDK import statements for Python, Go, TypeScript, etc.
  • Basic client configuration examples
  • Component/service naming examples

This cleanup will make the API reference pages more focused on the actual API methods and their documentation, while users can still access connection examples through the CONNECT tab in the web interface.

Trigger Events


If you want Promptless to make further changes on this PR, feel free to leave a comment tagging Promptless (It won't show up in the user drop down but Promptless will get it!)

[JT human]: This included removing a duplicated timeout session config info chunk--removed, and fixed link

Copy link

netlify bot commented Jun 28, 2025

Deploy Preview for viam-docs ready!

Name Link
🔨 Latest commit 92bc99d
🔍 Latest deploy log https://app.netlify.com/projects/viam-docs/deploys/6862f6159fb6dd0008216f64
😎 Deploy Preview https://deploy-preview-4422--viam-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
Lighthouse
Lighthouse
1 paths audited
Performance: 52 (🟢 up 5 from production)
Accessibility: 100 (no change from production)
Best Practices: 100 (no change from production)
SEO: 92 (no change from production)
PWA: 70 (no change from production)
View the detailed breakdown and full score reports

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

@viambot
Copy link
Member

viambot commented Jun 28, 2025

👋 Thanks for contributing! A reviewer will look at it on the next working day!

@CLAassistant
Copy link

CLAassistant commented Jun 28, 2025

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you all sign our Contributor License Agreement before we can accept your contribution.
1 out of 2 committers have signed the CLA.

✅ JessamyT
❌ promptless[bot]
You have signed the CLA already but the status is still pending? Let us recheck it.

Copy link
Contributor Author

promptless bot commented Jun 28, 2025

Just a reminder: If you'd like me to act on any feedback you have via Github comments, just type @Promptless in your suggestion and I'll get right on it! (I won't show up in the user dropdown, but I'll process any request that has @Promptless in the comment body.)

@JessamyT JessamyT changed the title DOCS-4095: Remove "Establish a connection" sections from all API reference pages DOCS-4095: Remove "Establish a connection" sections from API pages Jun 28, 2025
@JessamyT JessamyT changed the title DOCS-4095: Remove "Establish a connection" sections from API pages DOCS-4129: Remove "Establish a connection" sections from API pages Jun 30, 2025
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.

3 participants