fleet-memory/hindsight-docs
Nicolò Boschi 3d87ef5cee
doc: update cookbook (#479)
* doc: update cookbook

* fix(cookbook): preserve tag keys during sync, strip local .md links

- Fix extract_tags_from_readme/notebook to return dict[str,str] preserving
  sdk/topic keys instead of bare values, preventing topics like
  "Customer Service" from being misclassified as SDK
- Add strip_local_md_links() to remove relative .md references that
  would cause broken link errors in Docusaurus build

* ci: run test-doc-examples independently without waiting for test-rust-cli

Build the CLI directly in the job instead of downloading the artifact,
so test-doc-examples can start at the beginning in parallel with all other jobs.
2026-03-03 18:46:59 +01:00
..
blog docs: 0.4.15 release blog post and changelog (#477) 2026-03-03 15:52:56 +01:00
docs feat: add extension hooks for root routing and error headers (#470) 2026-03-03 10:50:03 +01:00
examples feat: add configurable Gemini/Vertex AI safety settings (#473) 2026-03-03 13:48:29 +01:00
src doc: update cookbook (#479) 2026-03-03 18:46:59 +01:00
static doc: update cookbook (#479) 2026-03-03 18:46:59 +01:00
versioned_docs Release v0.4.15 2026-03-03 15:03:42 +01:00
versioned_sidebars Release v0.4.15 2026-03-03 15:03:42 +01:00
.gitignore rename to hindsight (#2) 2025-11-25 19:28:26 +01:00
docusaurus.config.ts doc: improvements (#448) 2026-02-27 14:59:11 +01:00
package.json doc: hide next version (#226) 2026-01-29 08:46:21 +01:00
README.md rename to hindsight (#2) 2025-11-25 19:28:26 +01:00
sidebars.ts feat: add Pydantic AI integration to CI, release pipeline, and docs (#467) 2026-03-02 15:40:37 +01:00
tsconfig.json rename to hindsight (#2) 2025-11-25 19:28:26 +01:00
versions.json doc: release notes for 0.4.0 (#217) 2026-01-28 16:54:05 +01:00

Website

This website is built using Docusaurus, a modern static website generator.

Installation

npm install

Local Development

npm start

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

Build

npm run build

This command generates static content into the build directory and can be served using any static contents hosting service.

Deployment

Using SSH:

USE_SSH=true npm run deploy

Not using SSH:

GIT_USER=<Your GitHub username> npm run deploy

If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the gh-pages branch.