Skip to content

Feature/developing documentation landing page #4

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.

Sign up for GitHub

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

Merged
embarquech merged 2 commits into from
Mar 16, 2026
Merged

Feature/developing documentation landing page #4

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3cfcd3b
Modified the documentation links and footer
YanNaingWinn Mar 16, 2026
cbbf237
Redesigned landing page cards and fixed navigation/footer
YanNaingWinn Mar 16, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
101 changes: 45 additions & 56 deletions docs/source/_static/custom.css
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -106,67 +106,38 @@ a.headerlink { display: none; }
margin-bottom: 2rem;
}

/* ── Cards grid ───────────────────────────────────────────────────────── */
/* ── Cards container ──────────────────────────────────────────────────── */
#cryptnox-product-documentation {
display: grid;
grid-template-columns: repeat(3, 1fr);
gap: 1.5rem;
display: flex;
flex-direction: column;
gap: 0;
}

#cryptnox-product-documentation > h1,
#cryptnox-product-documentation > .toctree-wrapper {
grid-column: 1 / -1;
width: 100%;
}

#cryptnox-product-documentation > hr {
display: none;
}

/* ── Product cards ────────────────────────────────────────────────────── */
/* ── Product cards (full-width vertical rows) ─────────────────────────── */
#cryptnox-hardware-wallet,
#cryptnox-cli,
#cryptnox-sdk-for-python {
background: #fff;
border: 1px solid #e1e4e5;
border-radius: 8px;
padding: 1.75rem;
border-bottom: 1px solid #e1e4e5;
padding: 1.5rem 0;
display: flex;
flex-direction: column;
gap: 0.75rem;
gap: 0.5rem;
position: relative;
overflow: hidden;
transition: border-color 0.2s, box-shadow 0.2s, transform 0.2s;
box-shadow: 0 1px 3px rgba(0,0,0,0.06);
}

#cryptnox-hardware-wallet::before,
#cryptnox-cli::before,
#cryptnox-sdk-for-python::before {
content: '';
position: absolute;
top: 0; left: 0; right: 0;
height: 3px;
background: linear-gradient(90deg, #007bff, #fcb770);
opacity: 0;
transition: opacity 0.2s;
}

#cryptnox-hardware-wallet:hover,
#cryptnox-cli:hover,
#cryptnox-sdk-for-python:hover {
border-color: #007bff;
box-shadow: 0 4px 12px rgba(0, 123, 255, 0.12);
transform: translateY(-2px);
}

#cryptnox-hardware-wallet:hover::before,
#cryptnox-cli:hover::before,
#cryptnox-sdk-for-python:hover::before {
opacity: 1;
}

/* ── Card icon ────────────────────────────────────────────────────────── */
/* ── Card icon — rendered after h2 in RST, reordered first via flex ────── */
.card-icon {
order: -1;
width: 44px;
height: 44px;
background: rgba(0, 123, 255, 0.08);
Expand All @@ -189,12 +160,12 @@ a.headerlink { display: none; }
#cryptnox-hardware-wallet h2,
#cryptnox-cli h2,
#cryptnox-sdk-for-python h2 {
font-size: 1.1rem;
font-size: 1.05rem;
font-weight: 700;
color: #2c3e50;
border-bottom: none;
padding-bottom: 0;
margin-bottom: 0.25rem;
margin-bottom: 0;
}

/* ── Card description ─────────────────────────────────────────────────── */
Expand All @@ -203,8 +174,9 @@ a.headerlink { display: none; }
#cryptnox-sdk-for-python p {
color: #6b7a8a;
font-size: 0.9rem;
line-height: 1.65;
line-height: 1.6;
margin-bottom: 0;
max-width: 680px;
}

/* ── Card link list ───────────────────────────────────────────────────── */
Expand All @@ -213,8 +185,8 @@ a.headerlink { display: none; }
#cryptnox-sdk-for-python ul {
list-style: none;
padding-left: 0;
margin-top: auto;
padding-top: 0.5rem;
margin-top: 0.25rem;
margin-bottom: 0;
}

#cryptnox-hardware-wallet ul li,
Expand Down Expand Up @@ -251,8 +223,8 @@ a.headerlink { display: none; }
list-style: none;
padding: 0;
display: flex;
flex-wrap: wrap;
gap: 1.5rem;
flex-direction: column;
gap: 0.5rem;
}

#other-resources ul li {
Expand All @@ -264,17 +236,40 @@ a.headerlink { display: none; }
}

#other-resources a {
color: #6b7a8a !important;
color: #007bff !important;
font-size: 0.875rem;
font-weight: 400;
}

#other-resources a:hover {
color: #007bff !important;
color: #0056b3 !important;
text-decoration: underline;
}

/* ── Hide default Sphinx copyright footer ─────────────────────────────── */
.rst-content footer:not(.cnx-footer),
div[role="contentinfo"] {
display: none;
}

/* ── Card "View Docs" link — Yubico style ─────────────────────────────── */
#cryptnox-hardware-wallet ul li a,
#cryptnox-cli ul li a,
#cryptnox-sdk-for-python ul li a {
color: #007bff;
font-weight: 600;
font-size: 0.875rem;
text-decoration: none;
display: inline-flex;
align-items: center;
gap: 0.3rem;
}

/* ── Custom footer ────────────────────────────────────────────────────── */

/* ── Custom footer (hidden until JS moves it into content area) ────────── */
.cnx-footer {
display: none;
}
border-top: 1px solid #e1e4e5;
padding: 1.25rem 2rem;
background: #fcfcfc;
Expand Down Expand Up @@ -327,12 +322,6 @@ a.headerlink { display: none; }
}

/* ── Responsive ───────────────────────────────────────────────────────── */
@media (max-width: 860px) {
#cryptnox-product-documentation {
grid-template-columns: 1fr;
}
}

@media (max-width: 480px) {
.footer-inner {
flex-direction: column;
Expand Down
18 changes: 7 additions & 11 deletions docs/source/_templates/layout.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,21 +75,17 @@

{% endblock %}

{# ── Inject Home link as first sidebar nav item ────────────────────── #}
{# ── Move footer into visible content area ──────────────────────────── #}
{% block scripts %}
{{ super() }}
<script>
document.addEventListener('DOMContentLoaded', function() {
var menu = document.querySelector('.wy-menu-vertical > ul');
if (!menu) return;
var li = document.createElement('li');
li.className = 'toctree-l1{% if pagename == "index" %} current{% endif %}';
var a = document.createElement('a');
a.className = 'reference internal';
a.href = '{{ pathto("index") }}';
a.textContent = 'Home';
li.appendChild(a);
menu.insertBefore(li, menu.firstChild);
var footer = document.querySelector('.cnx-footer');
var content = document.querySelector('.wy-nav-content');
if (footer && content) {
content.appendChild(footer);
footer.style.display = 'block';
}
});
</script>
{% endblock %}
Expand Down
2 changes: 1 addition & 1 deletion docs/source/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

# -- Project information -----------------------------------------------------

project = 'Cryptnox Docs'
project = 'Cryptnox Product Documentation'
copyright = '2026, Cryptnox'
author = 'Cryptnox'
release = '1.0'
Expand Down
2 changes: 1 addition & 1 deletion docs/source/cryptnox-cli.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,4 @@ Cryptnox CLI
It handles card initialization, secure channel establishment, PIN management, seed generation,
key derivation, and transaction signing through a straightforward command interface.

`View CLI User Guide <./cryptnox-cli/index.html>`_
`View CLI User Guide <https://cryptnox.github.io/cryptnox-cli/>`_
2 changes: 1 addition & 1 deletion docs/source/cryptnox-sdk.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,4 @@ functionality into their own applications. It provides programmatic access to se
establishment, APDU communication, key derivation, and signing operations, allowing custom
wallet software and automation workflows to leverage the card's hardware security.

`View SDK Documentation <./cryptnox-sdk-py/index.html>`_
`View SDK Documentation <https://cryptnox.github.io/cryptnox-sdk-py/>`_
2 changes: 1 addition & 1 deletion docs/source/hardware-wallet.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,4 @@ Cryptnox Hardware Wallet
certified secure element. It provides hardware-secured private key storage and transaction signing
for cryptocurrency applications over NFC and contact (T=1) interfaces.

`View Technical Reference <./hardware-wallet/index.html>`_
`View Technical Reference <https://cryptnox.github.io/cryptnox-hardware-wallet/>`_
36 changes: 31 additions & 5 deletions docs/source/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,17 +9,25 @@ Cryptnox Product Documentation
hardware-wallet
cryptnox-cli
cryptnox-sdk
legal-notice


Cryptnox Hardware Wallet
=========================

.. raw:: html

<div class="card-icon">
<svg viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round">
<rect x="1" y="4" width="22" height="16" rx="2" ry="2"/>
<line x1="1" y1="10" x2="23" y2="10"/>
</svg>
</div>

*Cryptnox Hardware Wallet* is a JavaCard Open Platform 3 smartcard with an EAL6+ Common Criteria
certified secure element. It provides hardware-secured private key storage and transaction signing
for cryptocurrency applications over NFC and contact (T=1) interfaces.

* **Hardware Wallet Technical Reference** [`HTML <./hardware-wallet/index.html>`__]
* **Hardware Wallet Technical Reference** [`HTML <https://cryptnox.github.io/cryptnox-hardware-wallet/>`__]


-------------------------
Expand All @@ -28,11 +36,20 @@ for cryptocurrency applications over NFC and contact (T=1) interfaces.
Cryptnox CLI
=============

.. raw:: html

<div class="card-icon">
<svg viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round">
<polyline points="4 17 10 11 4 5"/>
<line x1="12" y1="19" x2="20" y2="19"/>
</svg>
</div>

*Cryptnox CLI* is a command-line tool for interacting with Cryptnox smartcards from the terminal.
It handles card initialization, secure channel establishment, PIN management, seed generation,
key derivation, and transaction signing through a straightforward command interface.

* **Cryptnox CLI User Guide** [`HTML <./cryptnox-cli/index.html>`__]
* **Cryptnox CLI User Guide** [`HTML <https://cryptnox.github.io/cryptnox-cli/>`__]


-------------------------
Expand All @@ -41,12 +58,21 @@ key derivation, and transaction signing through a straightforward command interf
Cryptnox SDK for Python
=========================

.. raw:: html

<div class="card-icon">
<svg viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round">
<polyline points="16 18 22 12 16 6"/>
<polyline points="8 6 2 12 8 18"/>
</svg>
</div>

*Cryptnox SDK for Python* is a library that enables developers to integrate Cryptnox smartcard
functionality into their own applications. It provides programmatic access to secure channel
establishment, APDU communication, key derivation, and signing operations, allowing custom
wallet software and automation workflows to leverage the card's hardware security.

* **Cryptnox SDK for Python** [`HTML <./cryptnox-sdk-py/index.html>`__]
* **Cryptnox SDK for Python** [`HTML <https://cryptnox.github.io/cryptnox-sdk-py/>`__]


-------------------------
Expand All @@ -56,4 +82,4 @@ Other resources
===============

* `Cryptnox Website <https://www.cryptnox.com>`_
* `Cryptnox on GitHub <https://github.com/nicokempe>`_
* `Cryptnox on GitHub <https://github.com/cryptnox>`_
5 changes: 0 additions & 5 deletions docs/source/legal-notice.rst
View file
Open in desktop

This file was deleted.

Loading