fleet-memory/hindsight-docs
Nicolò Boschi 349c112c61
docs: add supported platforms and Windows installation guide (#700)
* docs: add supported platforms section and Windows installation guide

Adds a platform compatibility table (Linux, macOS, Windows) and a
dedicated Windows setup section with step-by-step instructions for
installing PostgreSQL + pgvector and running Hindsight natively.
Follows up on #699 which added Windows native support.

Also fixes a ty type-check error in metrics.py for the conditional
resource module import.

* chore: sync generated clients and lock file after #699

Regenerate client SDKs to pick up ValidationError model changes
and update uv.lock with platform-specific uvloop/winloop deps.

* docs: update Windows section — pg0 now supports Windows

pg0 v0.12.0 added Windows support, so embedded DB works everywhere.
Restructure Windows section to show simple install-and-run first,
with external PostgreSQL as an optional alternative.

* chore: sync generated docs skill and openapi references
2026-03-26 12:01:30 +01:00
..
blog blog: Your AWS Strands Agent Forgets Everything Between Runs. Here's the Fix. (#685) 2026-03-25 10:37:37 -04:00
docs docs: add supported platforms and Windows installation guide (#700) 2026-03-26 12:01:30 +01:00
examples feat: 4-tab code parity across all documentation examples (#613) 2026-03-19 11:31:51 +01:00
scripts feat: 4-tab code parity across all documentation examples (#613) 2026-03-19 11:31:51 +01:00
src feat: add LiteLLM LLM provider for Bedrock and 100+ providers (#679) 2026-03-25 14:17:38 +01:00
static fix: include Pydantic v2 fields in ValidationError OpenAPI schema (#697) 2026-03-26 11:25:46 +01:00
versioned_docs feat: add Strands Agents SDK integration with Hindsight memory tools (#659) 2026-03-24 17:21:30 +01:00
versioned_sidebars feat: add Strands Agents SDK integration with Hindsight memory tools (#659) 2026-03-24 17:21:30 +01:00
.gitignore rename to hindsight (#2) 2025-11-25 19:28:26 +01:00
docusaurus.config.ts feat(docs): Integrations Hub + unified page hero (#620) 2026-03-19 20:29:55 +01:00
package.json feat: 4-tab code parity across all documentation examples (#613) 2026-03-19 11:31:51 +01:00
README.md rename to hindsight (#2) 2025-11-25 19:28:26 +01:00
sidebars.ts feat: add Strands Agents SDK integration with Hindsight memory tools (#659) 2026-03-24 17:21:30 +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.