Skip to content

docs: fix site audit issues in titles, descriptions and links - #749

Merged
arsenovicAtNominal merged 3 commits into
mainfrom
docs/site-audit-fixes
Nov 12, 2026
Merged

arsenovicAtNominal merged 3 commits into
mainfrom
docs/site-audit-fixes

Conversation

@smithednominal

Copy link
Copy Markdown
Contributor

Fixes from an external automated audit of dev.nominal.io/instro/:

  • Source pages under _modules/ get a meta description, and API pages end their titles in " - instro" rather than " - instro Python API".
  • The GW Instek GPD-3303 and Keysight N5700 pages use the generated description instead of "A driver for InstroPSU".
  • Example titles come from each script's first docstring line, so those lines are shorter.
  • The changelog no longer links to the private instrumentation repo's commits, issues and compares, and version headings are plain text.
  • Link text "here" names the LabJack thermocouple guide.
  • Pages that had few links in point to Aardvark, the I2C system definition, and Modbus TCP and RTU.

Summary

Wording/linking changes to improve search/llm/human optimization
Briefly describe what this PR does and why. If it fixes an existing issue, link it (e.g. Fixes #123).

Type of change

  • Bug fix (fix)
  • New feature (feat)
  • Breaking change (feat! / fix!)
  • Refactor (refactor)
  • Documentation (docs)
  • Chore / tooling (chore)

Verification

How did you verify this change works? Provide evidence the reviewer can evaluate without reproducing your setup — e.g. test output, screenshots, logs, repro steps + result. If the change is hardware-specific and you don't have the device, say so.
Automated audit

Tests

  • Unit tests added or updated
  • Existing tests cover this change
  • No tests — explain why:
    Words, words, words (changes are all to text which we will continue auditing periodically)

Checklist

  • PR title follows Conventional Commits (e.g. feat(driver): add support for Keysight E36300)
  • I have read CONTRIBUTING.md
  • Documentation updated if user-facing behavior changed
  • Code follows the style/conventions of the surrounding code

Notes for reviewers

Optional — call out specific files, edge cases, or decisions you'd like eyes on.

Fixes from a Semrush audit of dev.nominal.io/instro/:

- Source pages under _modules/ get a meta description, and API pages
  end their titles in " - instro" rather than " - instro Python API".
- The GW Instek GPD-3303 and Keysight N5700 pages use the generated
  description instead of "A driver for InstroPSU".
- Example titles come from each script's first docstring line, so
  those lines are shorter.
- The changelog no longer links to the private instrumentation repo's
  commits, issues and compares, and version headings are plain text.
- Link text "here" names the LabJack thermocouple guide.
- Pages that had few links in point to Aardvark, the I2C system
  definition, and Modbus TCP and RTU.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

@claude claude Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Claude Code Review

This repository is configured for manual code reviews. Comment @claude review for a one-time review, or @claude review always to subscribe this PR to a review on every future push.

Tip: disable this comment in your organization's Code Review settings.

@mintlify

mintlify Bot commented Nov 12, 2026 •

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated
instro 🟢 Ready View Preview Nov 12, 2026, 4:22 PM

💡 Tip: Enable Automations to automatically generate PRs for you.

@claude

claude Bot commented Nov 12, 2026 •

Copy link
Copy Markdown
Contributor

PR #749 was updated after the trigger (3587074 -> b0ef85a). Push again or mention Claude to run on the latest version.

@greptile-apps

greptile-apps Bot commented Nov 12, 2026 •

Copy link
Copy Markdown

RetriggerView in GreptileConfidence Score: 5/5

[Medium impact] The PR appears safe to merge.

Summary

Updates documentation titles, descriptions, and links.

  • Generated documentation pages get clearer search titles and descriptions.
  • Documentation pages link readers to related device and protocol guides.
  • Changelog entries no longer link to the private instrumentation repository.
  • Example pages get shorter titles from their scripts' first lines.

No actionable issues found. Checks were limited to source review; no documentation build or visual check was run.

Reviews (1) · Last reviewed commit: "docs: fix site audit issues in titles, d..." · Reviewed by Greptile

@smithednominal
smithednominal enabled auto-merge (squash) November 12, 2026 16:44
@arsenovicAtNominal
arsenovicAtNominal merged commit 0546189 into main Nov 12, 2026
22 checks passed
@arsenovicAtNominal
arsenovicAtNominal deleted the docs/site-audit-fixes branch November 12, 2026 17:29
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.

2 participants