Skip to content

HagiCode-org/docs

Repository files navigation

HagiCode Documentation

简体中文

This repository contains the standalone HagiCode documentation site built with Astro and Starlight.

Product overview

The docs site is where users learn the platform: product overviews, installation guides, tutorials, blog posts, and downloadable configuration presets all live here.

What the site covers

  • Product introductions and onboarding guides for new users
  • Step-by-step installation and configuration documentation
  • Blog content and updates for the HagiCode ecosystem
  • Preset files and static assets referenced by public docs pages

Repository layout

  • src/content/docs/ - documentation pages and blog content
  • src/components/ and src/layouts/ - site UI building blocks
  • public/ - static assets, downloadable presets, and shared media
  • scripts/ and tests/ - verification helpers for docs quality and routing behavior

Local development

npm install
npm run dev
npm run build
npm run preview

The local docs server runs on http://localhost:31265 by default.

Multi-repo changelog data

The docs site now maintains static changelog datasets under src/data/changelog/ for core, web, and desktop. These files are generated by scripts/generate-multi-repo-changelog.mjs from adjacent Git tag windows in repos/hagicode-core, repos/web, and repos/hagicode-desktop.

npm run changelog:generate
npm run verify:repo-changelog

The third source is intentionally desktop, not site. That assumption follows the OpenSpec change text, while keeping the source mapping configurable in the generator for future switches. The generator only writes inside repos/docs/src/data/changelog/; the source repositories remain read-only inputs.

Desktop version data

Desktop download data is fetched at runtime from the canonical index endpoint published by repos/index. When runtime loading reaches terminal failure, docs falls back to the Index Desktop history page at https://index.hagicode.com/desktop/history/. repos/index remains a referenced dependency only; the stable fallback surface is https://index.hagicode.com/desktop/history/ plus https://index.hagicode.com/desktop/index.json. This repository still serves public/version-index.json as a local snapshot for offline fallback, but maintainers should investigate the runtime fetch chain and the index deployment before changing docs UI behavior.

Ecosystem role

Use this repository when the goal is end-user education and public documentation. Product storytelling lives in repos/site, while application behavior lives in repos/web, repos/hagicode-desktop, and repos/hagicode-core.

About

Official HagiCode documentation site with product guides, installation docs, tutorials, presets, and blog content.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Contributors