Repository navigation
docs: fix site audit issues in titles, descriptions and links - #749
Merged
Merged
Conversation
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>
Contributor
There was a problem hiding this comment.
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.
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Automations to automatically generate PRs for you. |
Contributor
[Medium impact] The PR appears safe to merge. SummaryUpdates documentation titles, descriptions, and links.
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
enabled auto-merge (squash)
November 12, 2026 16:44
arsenovicAtNominal
disabled auto-merge
November 12, 2026 17:29
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixes from an external automated audit of dev.nominal.io/instro/:
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
fix)feat)feat!/fix!)refactor)docs)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
Words, words, words (changes are all to text which we will continue auditing periodically)
Checklist
feat(driver): add support for Keysight E36300)Notes for reviewers
Optional — call out specific files, edge cases, or decisions you'd like eyes on.