Skip to content

website: add the Back to StackQL Docs link and the source repo link #8

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
jeffreyaven merged 3 commits into from
Oct 6, 2026
Merged

website: add the Back to StackQL Docs link and the source repo link #8

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
34cb34b
docs: regenerate with @stackql/provider-utils 0.7.11 and the source r…
jeffreyaven Oct 6, 2026
d07c68a
website: add the Back to StackQL Docs sidebar link
jeffreyaven Oct 6, 2026
8ad2ddc
docs: bump @stackql/provider-utils to 0.7.12
jeffreyaven Oct 6, 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
4 changes: 3 additions & 1 deletion Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,7 @@
SHELL := /bin/bash

PROVIDER := github
SOURCE_PROJECT ?= https://github.com/stackql-registry/stackql-provider-$(PROVIDER)
VERSION := v00.00.00000
SPEC_URL := https://raw.githubusercontent.com/github/rest-api-description/main/descriptions/api.github.com/api.github.com.json
SPEC_FILE := provider-dev/downloaded/api.github.com.json
Expand Down Expand Up @@ -150,7 +151,8 @@ docs:
--provider-name $(PROVIDER) \
--provider-dir ./$(PROVIDER_DIR) \
--output-dir ./$(WEBSITE_DIR) \
--provider-data-dir ./provider-dev/docgen/provider-data
--provider-data-dir ./provider-dev/docgen/provider-data \
--source-project $(SOURCE_PROJECT)
bash bin/fix-doc-links.sh $(WEBSITE_DIR)/docs/services

docs-build:
Expand Down
68 changes: 55 additions & 13 deletions package-lock.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
},
"dependencies": {
"@stackql/pgwire-lite": "^1.0.2",
"@stackql/provider-utils": "0.7.7",
"@stackql/provider-utils": "0.7.12",
"js-yaml": "^4.1.0"
},
"keywords": [
Expand Down
1 change: 1 addition & 0 deletions website/docs/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ Web-based version-control and collaboration.

total services: __48__
total resources: __480__
source project: __[stackql-provider-github](https://github.com/stackql-registry/stackql-provider-github)__

:::

Expand Down
10 changes: 10 additions & 0 deletions website/sidebars.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,16 @@ const providerTitle = config.title.replace(/^StackQL /, '').replace(/ Provider$/

const sidebars = {
mainSidebar: [
// Way back to the main stackql.io docs, as on the query library site.
// '/stackqldocs' is this site's redirect page (src/pages/stackqldocs.js).
// The arrow and divider come from the .sidebar-back-link rules in the
// site stylesheet.
{
type: 'link',
label: 'Back to StackQL Docs',
href: '/stackqldocs',
className: 'sidebar-back-link',
},
{
type: 'link',
label: 'All Providers',
Expand Down
22 changes: 21 additions & 1 deletion website/src/css/custom.css
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -256,4 +256,24 @@ div:has(> .vhsImage) {
.providerDocColumn {
width: 100%;
}
}
}

/*
* sidebar: back link to the main stackql.io docs (the first item in
* sidebars.js). Same treatment as the query library site: bold label,
* leading arrow drawn here so the label stays plain text, divider below.
*/
.sidebar-back-link {
border-bottom: 1px solid var(--ifm-color-emphasis-300);
padding-bottom: 0.5rem;
margin-bottom: 0.5rem !important;
}

.sidebar-back-link .menu__link {
font-weight: 600;
}

.sidebar-back-link .menu__link::before {
content: '\2190';
margin-right: 0.5rem;
}
Loading