From caee8efecc78f8dc5c0d1d32d6b45d7bcf1ae7fe Mon Sep 17 00:00:00 2001 From: Cryptnox SEO Manager Date: Tue, 11 Aug 2026 11:25:06 +0200 Subject: [PATCH] Optimize docs for AI/search discoverability The published site had no robots.txt (404), no llms.txt (404), and the sphinx-sitemap output covers only the root project's 3 pages of 16. Adds, via html_extra_path: - robots.txt: explicit allow-all + pointers to both sitemaps - llms.txt: curated index of every doc section and PDF for LLM crawlers - sitemap-docs.xml: static full sitemap (16 URLs incl. SDK subsites and PDFs) complementing the generated /sitemap.xml Plus a content and metadata pass: - index.rst: the wallet card also carries the FIDO Alliance certified FIDO2/U2F applets (CTAP2.1, Level 1) and doubles as a FIDO2 security key; explicit coverage entities (BIP32, secp256k1/NIST P-256, MuSig2 BIP-327); product-page and tech-spec links under Other resources - layout.html: unify the JSON-LD publisher with the brand entity https://cryptnox.com/#organization (was a detached 'Cryptnox Docs' org); repoint og:image, twitter:image and the logo away from wp-content paths that 404 on GitHub Pages; og:image dimensions corrected to the replacement image's actual 512x512 - conf.py: add FIDO2, MuSig2, BIP-327 and secp256k1 to the keywords The llms.txt product note states both card interfaces (ISO/IEC 7816 contact and ISO/IEC 14443 contactless) and the USB smart card readers sold alongside the cards. No html_last_updated_fmt: Sphinx computes that value once per build from the current time, not per source file, so on a CI-deployed site every page would advertise the last deploy date as its content date. Co-Authored-By: Claude Fable 5 Co-Authored-By: Claude Opus 5 --- docs/source/_extra/llms.txt | 44 +++++++++++++++++++++++++++++ docs/source/_extra/robots.txt | 5 ++++ docs/source/_extra/sitemap-docs.xml | 19 +++++++++++++ docs/source/_templates/layout.html | 34 +++++++++++----------- docs/source/conf.py | 3 +- docs/source/index.rst | 12 +++++++- 6 files changed, 99 insertions(+), 18 deletions(-) create mode 100644 docs/source/_extra/llms.txt create mode 100644 docs/source/_extra/robots.txt create mode 100644 docs/source/_extra/sitemap-docs.xml diff --git a/docs/source/_extra/llms.txt b/docs/source/_extra/llms.txt new file mode 100644 index 0000000..a144309 --- /dev/null +++ b/docs/source/_extra/llms.txt @@ -0,0 +1,44 @@ +# Cryptnox Product Documentation + +> Official technical documentation for Cryptnox SA (Carouge, Geneva, +> Switzerland) — NFC smart cards for hardware wallets, FIDO2 authentication and +> PIV identity, plus SDKs, CLI tools and hardware reference material. +> Main website: https://www.cryptnox.com — Shop: https://shop.cryptnox.com +> Source code: https://github.com/cryptnox + +Cryptnox security devices are smart cards: the hardware wallet, FIDO2 and PIV +products are ISO/IEC 7816 contact and ISO/IEC 14443 contactless (NFC) cards. +Cryptnox also sells USB smart card readers (USB-A, USB-C CCID and +NFC/contactless models) for using the cards with a computer — see +https://shop.cryptnox.com. The hardware wallet card also carries the FIDO +Alliance certified FIDO2 and U2F applets (FIDO2 CTAP2.1, Level 1), so it +doubles as a FIDO2 security key. + +## Hardware Wallet Technical Reference + +- [Hardware Wallet v2.0 (HTML)](https://docs.cryptnox.com/cryptnox-hardware-wallet/v2.0/): technical specifications, lifecycle management, secure channel, authentication, seed management, key derivation, EC signatures, MuSig2 (BIP-327) commands, status codes, security model, supported algorithms and curves, JavaCard platform details +- [Hardware Wallet v2.0 (PDF)](https://docs.cryptnox.com/cryptnox-hardware-wallet/v2.0/cryptnox-hardware-wallet-v2.0.pdf) +- [Hardware Wallet v1.6 (HTML)](https://docs.cryptnox.com/cryptnox-hardware-wallet/v1.6/) +- [Hardware Wallet v1.6 (PDF)](https://docs.cryptnox.com/cryptnox-hardware-wallet/v1.6/cryptnox-hardware-wallet-v1.6.pdf) + +## Command-line tool + +- [Cryptnox CLI User Guide (HTML)](https://docs.cryptnox.com/cryptnox-cli/): installation, supported hardware, command reference, interactive mode, BIP39 passphrase support, exit codes, examples +- [Cryptnox CLI User Guide (PDF)](https://docs.cryptnox.com/cryptnox-cli/cryptnox-cli.pdf) + +## SDKs + +- [Python SDK (HTML)](https://docs.cryptnox.com/cryptnox-sdk-py/): API reference for the cryptnox_sdk_py package, class diagrams, connection components, reader hierarchy +- [Python SDK (PDF)](https://docs.cryptnox.com/cryptnox-sdk-py/cryptnox-sdk-py.pdf) +- [ESP32 SDK (HTML)](https://docs.cryptnox.com/cryptnox-sdk-esp32/) +- [ESP32 SDK (PDF)](https://docs.cryptnox.com/cryptnox-sdk-esp32/cryptnox-sdk-esp32.pdf) +- [Arduino SDK (HTML)](https://docs.cryptnox.com/cryptnox-sdk-arduino/) +- [Arduino SDK (PDF)](https://docs.cryptnox.com/cryptnox-sdk-arduino/cryptnox-sdk-arduino.pdf) +- [C++ SDK (HTML)](https://docs.cryptnox.com/cryptnox-sdk-cpp/) +- [C++ SDK (PDF)](https://docs.cryptnox.com/cryptnox-sdk-cpp/cryptnox-sdk-cpp.pdf) + +## Optional + +- [Documentation index](https://docs.cryptnox.com/) +- [Cryptnox website](https://www.cryptnox.com) +- [Cryptnox on GitHub](https://github.com/cryptnox) diff --git a/docs/source/_extra/robots.txt b/docs/source/_extra/robots.txt new file mode 100644 index 0000000..2824de2 --- /dev/null +++ b/docs/source/_extra/robots.txt @@ -0,0 +1,5 @@ +User-agent: * +Allow: / + +Sitemap: https://docs.cryptnox.com/sitemap.xml +Sitemap: https://docs.cryptnox.com/sitemap-docs.xml diff --git a/docs/source/_extra/sitemap-docs.xml b/docs/source/_extra/sitemap-docs.xml new file mode 100644 index 0000000..8627d8f --- /dev/null +++ b/docs/source/_extra/sitemap-docs.xml @@ -0,0 +1,19 @@ + + + https://docs.cryptnox.com/ + https://docs.cryptnox.com/cryptnox-hardware-wallet/v2.0/ + https://docs.cryptnox.com/cryptnox-hardware-wallet/v2.0/cryptnox-hardware-wallet-v2.0.pdf + https://docs.cryptnox.com/cryptnox-hardware-wallet/v1.6/ + https://docs.cryptnox.com/cryptnox-hardware-wallet/v1.6/cryptnox-hardware-wallet-v1.6.pdf + https://docs.cryptnox.com/cryptnox-cli/ + https://docs.cryptnox.com/cryptnox-cli/cryptnox-cli.pdf + https://docs.cryptnox.com/cryptnox-sdk-py/ + https://docs.cryptnox.com/cryptnox-sdk-py/cryptnox-sdk-py.pdf + https://docs.cryptnox.com/cryptnox-sdk-esp32/ + https://docs.cryptnox.com/cryptnox-sdk-esp32/cryptnox-sdk-esp32.pdf + https://docs.cryptnox.com/cryptnox-sdk-arduino/ + https://docs.cryptnox.com/cryptnox-sdk-arduino/cryptnox-sdk-arduino.pdf + https://docs.cryptnox.com/cryptnox-sdk-cpp/ + https://docs.cryptnox.com/cryptnox-sdk-cpp/cryptnox-sdk-cpp.pdf + https://docs.cryptnox.com/genindex.html + diff --git a/docs/source/_templates/layout.html b/docs/source/_templates/layout.html index b9dd837..ad0ebfb 100644 --- a/docs/source/_templates/layout.html +++ b/docs/source/_templates/layout.html @@ -13,9 +13,9 @@ - - - + + + @@ -23,7 +23,7 @@ - +