Skip to content
GingerPrivacyPublic

About

No description, website, or topics provided.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Repository files navigation

GingerDoc

Documentation for GingerWallet, built with Astro + Starlight and searched with Pagefind.

Published to https://docs.gingerwallet.io from the gh-pages branch by .github/workflows/docs.yml on every push to master.

Run on localhost

Use Node.js 22.12.0 or newer. CI builds and deploys with Node.js 24.

npm install
npm run dev

The dev server prints a local URL (http://localhost:4321 by default) and reloads on save — including changes to src/styles/custom.css, so no rebuild is needed while working on styles.

Commands

Command What it does
npm run dev Start the dev server
npm run build Build the production site into dist/ and run Pagefind
npm run preview Serve dist/ locally — the only way to test search
npm run check Type-check the config and validate page frontmatter
npm run test:search Test search filters, keyboard/mobile controls and local resources against the production build

Search is generated at build time, so it only works against npm run preview, never against npm run dev.

Run npx playwright install chromium once before running the browser tests locally. Build the site before npm run test:search; the tests start a local preview server.

Search visibility

Pages are generated as complete HTML, including their content, canonical URL, language alternates and structured data. Translations have their own URLs and normal links in the page footer, which also work without JavaScript. Browser language detection is a visitor convenience; recognized crawlers stay on the URL they requested. The 404 page and legacy redirects are marked noindex and excluded from the sitemap.

Run python scripts/check-seo.py after building to verify every page's metadata, reciprocal language links, structured data and sitemap coverage. Deployment runs the same check before publishing. Browser tests verify language detection with search crawler user agents as well as ordinary browsers.

The public robots.txt allows crawling and advertises the sitemap. Submit that sitemap in Google Search Console and Bing Webmaster Tools for the documentation hostname, and use their indexing reports to check actual coverage. A successful build or an accessible sitemap does not confirm indexing.

Cloudflare security rules also affect crawler access. Check its security events for denied Googlebot, Bingbot, OAI-SearchBot and other search crawler requests. OpenAI recommends allowing OAI-SearchBot and its published IP ranges for ChatGPT search. Search access and model-training access are separate choices; this project does not require granting new training permissions.

Google's AI search guidance uses the same crawlability and content requirements as regular search. It does not require llms.txt or special AI markup. Keep the visible guides accurate, link related answers and monitor indexing after content or hosting changes.

Writing content

Pages live in src/content/docs/ as .md / .mdx. The file path is the URL: src/content/docs/using-ginger/fee.md → /using-ginger/fee/.

Every page needs a title in its frontmatter:

---
title: Fees
---

Body text starts here — do not repeat the title as an `# h1`.

Optional frontmatter worth knowing:

---
title: Bitcoin Purchase via Ginger Wallet
description: Shown in search results and social previews.
sidebar:
  label: Buy Bitcoin   # shorter label for the nav
  order: 3             # manual ordering within a group
---

Nav order and grouping come from the per-topic JSON files in src/navigation/, read by src/manual-sidebar.mjs. Register new pages in the appropriate topic and reading level; follow the navigation guide.

Search starts with beginner and everyday guides. Readers can select advanced guides or all guides in the search dialog. Set reader_level to beginner, everyday, or advanced in page frontmatter; this drives both the search filter and the result's reading-level label. Existing unclassified pages default to beginner. New search UI strings live in src/search-labels.ts for future locales.

Theme

Colours, fonts and heading styles are in src/styles/custom.css. The logo is src/assets/logo.svg and the favicon is public/favicon.svg.

Poppins is bundled from the pinned @fontsource/poppins package (OFL-1.1). Visitors load the font files from this site; no Google Fonts request is needed. The font's copyright and license ship in public/fonts/OFL-Poppins.txt.

Hosting privacy

The generated site uses local fonts and local Pagefind search. Cloudflare can inject its Web Analytics beacon into responses after deployment, independently of this repository. A GitHub merge cannot switch off that account setting.

In the gingerwallet.io zone, open Rules > Overview and create a Configuration Rule named Disable analytics on documentation. Use the custom filter expression (http.host eq "docs.gingerwallet.io"), add Disable Real User Monitoring (RUM), and deploy the rule. This covers every path on the documentation hostname while preserving other hostnames' settings. If this rule already exists, update it instead of creating a duplicate.

Cloudflare's RUM configuration setting takes precedence over Web Analytics rules. Keep this hostname-specific rule active when changing the zone's analytics configuration.

After saving, check the live HTML for static.cloudflareinsights.com and confirm that the browser makes no beacon request. Checking only dist/ does not verify the Cloudflare setting.

About

No description, website, or topics provided.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Used by

Contributors

Languages