Skip to content

docs: harden navigation, metadata, and deployment checks - #19

Merged
BotshareAI merged 1 commit into
mainfrom
docs/usability-seo-hardening
Sep 1, 2026
Merged

docs: harden navigation, metadata, and deployment checks#19
BotshareAI merged 1 commit into
mainfrom
docs/usability-seo-hardening

Conversation

@BotshareAI

Copy link
Copy Markdown
Contributor

Summary

  • add intent-first task routes for assembly, software startup, mapping, fault isolation, sensor integration, and customer workflow validation
  • generate breadcrumbs, Path chips, sibling navigation, related links, repository ownership, revision dates, feedback, and contact controls at build time
  • add page descriptions, JSON-LD, abbreviations, project status, a custom 404, real UI screenshots, and a self-hosted project logo
  • add strict generated-link checks and post-deployment root/HTTPS smoke tests
  • enable navigation progress and upgrade MkDocs Material

Validation

  • mkdocs build --strict passes
  • scripts/check_docs.sh passes with 0 warnings
  • all 62 index pages have explicit titles
  • 26 priority pages have unique descriptions
  • generated HTML contains semantic breadcrumbs, related links, owning repository, revision date, feedback link, and JSON-LD

Live finding

The deployed root now serves the new site, so the stale-root issue is resolved. However, http://docs.openamrobot.ai/ currently returns 200 OK instead of redirecting to HTTPS, and HTTPS was not reachable from the audit environment. The post-deploy smoke test intentionally surfaces this until GitHub Pages HTTPS enforcement/custom-domain certificate configuration is corrected.

…f-by: BotshareAI <175946218+BotshareAI@users.noreply.github.com>
@BotshareAI
BotshareAI merged commit b14c186 into main Sep 1, 2026
2 of 4 checks passed
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