Skip to content

docs: initial refactor of docs #1366

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

Open
dkonieczek wants to merge 28 commits into
base: develop
Choose a base branch
from
Open

docs: initial refactor of docs #1366

Show file tree
Hide file tree
Changes from 8 commits
Commits
Show all changes
28 commits
Select commit Hold shift + click to select a range
3558604
docs: initial refactor of docs
dkonieczek Aug 22, 2025
647fb9c
chore: merge develop
dkonieczek Aug 22, 2025
6b97f6b
refactor: refactor to path routing, add permalink support, fix feed g…
dkonieczek Sep 9, 2025
f0e4791
docs: many doc changes
dkonieczek Oct 1, 2025
de8df9b
chore: merge develop
dkonieczek Oct 1, 2025
4ff58c3
refactor: cleanup from review
dkonieczek Oct 2, 2025
29162ce
refactor: more fixes from review
dkonieczek Oct 2, 2025
857666b
refactor: pr review
dkonieczek Oct 2, 2025
6316b62
refactor: more fixes
dkonieczek Oct 2, 2025
511529a
fix: route base path for non-localhost
dkonieczek Oct 2, 2025
66fd938
refactor: more revisions, add legend
dkonieczek Oct 10, 2025
4f7926a
fix: base url
dkonieczek Oct 10, 2025
b753591
fix: legend links
dkonieczek Oct 10, 2025
d16e865
fix: change content width and legend breakpoint
dkonieczek Oct 14, 2025
c6871d6
docs: improve recommendations docs
dkonieczek Oct 23, 2025
59ad862
docs: rename legacy recs route
dkonieczek Oct 23, 2025
062d2a7
chore: generate package-lock.json
dkonieczek Oct 23, 2025
8df0721
chore: merge develop and resolve package-lock.json
dkonieczek Oct 23, 2025
02b4f37
docs: add qa checklist and performance optimization pages
dkonieczek Nov 4, 2025
4c26499
docs: add initial platform integration docs
dkonieczek Nov 13, 2025
4341ea2
docs: pairing feedback
dkonieczek Nov 17, 2025
30f255d
docs: refactor search store docs
dkonieczek Nov 18, 2025
b9d35d0
chore: merge develop & rebuild package-lock.json
dkonieczek Nov 20, 2025
cc63449
docs: update variants doc, add addToCart controller doc, result mask doc
dkonieczek Nov 20, 2025
05df1ab
docs: pr feedback, make instantiator config.branch optional
dkonieczek Nov 28, 2025
e63f6cb
docs: add marked-alerts and dark mode switcher
dkonieczek Dec 9, 2025
4e30370
docs: undo createWebHistory router
dkonieczek Dec 9, 2025
4ad7afc
docs: add search method to recommendation controller
dkonieczek Dec 10, 2025
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
4 changes: 3 additions & 1 deletion .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,4 +10,6 @@ packages/snap-preact-demo/tests/cypress/videos
packages/snap-preact-demo/tests/cypress/screenshots
packages/snap-preact-demo/.lighthouseci
packages/snap-preact-demo/tests/lighthouse/runs
packages/snapps/*/
packages/snapps/*/
packages/**/docs
docs/snap-docs.json
33 changes: 33 additions & 0 deletions 404.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
<!DOCTYPE html>

<html lang="en">
<head>
<meta charset="UTF-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<link rel="stylesheet" href="./assets/styles.css">
<link rel="stylesheet" href="./assets/hljs.css">
<link rel="preconnect" href="https://fonts.gstatic.com">
<link rel="preconnect" href="https://ka-f.fontawesome.com">
<link rel="preconnect" href="https://cdn.jsdelivr.net">
<link rel="preconnect" href="https://kit.fontawesome.com">
<link rel="preconnect" href="https://fonts.googleapis.com">
<script src="https://cdn.jsdelivr.net/npm/[email protected]/lib/marked.min.js"></script>
<script src="https://cdn.jsdelivr.net/gh/highlightjs/[email protected]/build/highlight.min.js"></script>
<script src="https://kit.fontawesome.com/c1798fb82d.js" crossorigin="anonymous"></script>
<link href="https://fonts.googleapis.com/css2?family=Inter:[email protected]&display=swap" rel="stylesheet">
<title>Snap Documentation</title>

<link rel="icon" href="./athos_favicon.svg">

<script src="https://snapui.searchspring.io/vrntn7/bundle.js" id="searchspring-context"></script>
</head>
<body>
<div id="app"></div>

<script src="https://cdn.jsdelivr.net/npm/[email protected]"></script>
<script src="https://cdn.jsdelivr.net/npm/vue-router@4"></script>
<script src="doc-app.js"></script>

</body>
</html>
68 changes: 58 additions & 10 deletions assets/styles.css
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ html {
body {
margin: 0;
background: #fafafa;
font-family: 'Ubuntu', sans-serif;
font-family: 'Inter', sans-serif;
-webkit-font-smoothing: antialiased;
}

Expand All @@ -37,10 +37,6 @@ a:hover {
text-decoration: underline;
}

p, table {
font-family: 'Roboto', sans-serif;
}

table {
border-collapse: collapse;
background-color: #ffffff;
Expand Down Expand Up @@ -108,6 +104,9 @@ table td {
#navigation {
overflow-y: auto;
max-height: calc(100% - 170px);
display: flex;
flex-direction: column;
height: inherit;
}

#navigation ul {
Expand All @@ -120,7 +119,7 @@ table td {
color: inherit;
display: inline-block;
width: calc(100% - 20px);
padding: 5px 10px;
padding: 3px 10px;
font-size: 0.9em;
}

Expand Down Expand Up @@ -151,6 +150,48 @@ table td {
float: right;
}

#content .permalink {
all: initial;
position: absolute;
top: -1em;
color: green;
}
#content .scrolled-to {
background: var(--athos-secondary);
}

#content h2,
#content h3,
#content h4,
#content h5,
#content h6 {
cursor: pointer;
position: relative;
background: transparent;
transition: background 0.5s ease;
}

#content h2::before,
#content h3::before,
#content h4::before,
#content h5::before,
#content h6::before {
content: '🔗';
position: absolute;
left: -1.2em;
opacity: 0;
transition: opacity 0.25s ease;
}

#content h2:hover::before,
#content h3:hover::before,
#content h4:hover::before,
#content h5:hover::before,
#content h6:hover::before {
opacity: 0.5;
transition: opacity 0.25s ease;
}

#markdown {
padding: 50px 100px;
max-width: 1500px;
Expand Down Expand Up @@ -183,20 +224,20 @@ table td {
border: none;
}

.section:last-child {
margin-top: auto;
}

.section .links {
margin: 5px 0 20px;
}

.section .links .sublinks {
font-size: 90%;
margin: 0 10px;
}

pre {
font-family: "SFMono-Regular",Consolas,"Liberation Mono",Menlo,Courier,monospace;
padding: 16px;
overflow: auto;
line-height: 1.2;
background-color: #fafafa;
border-radius: 0px;
border: 1px solid #eee;
Expand Down Expand Up @@ -270,4 +311,11 @@ code:not([class]) {
#markdown {
padding: 10px 30px;
}

.section:last-child {
position: unset;
bottom: unset;
width: unset;
}

}
Loading
Loading