fleet-memory/hindsight-docs
DK09876 d405b4feed
ci: finalize test for the documentation code (#57)
* Fix main-methods.py: entities is a dict, use .items() and .canonical_name

* Migrate docs to use CodeSnippet components

- Convert quickstart.md, retain.md, recall.md, reflect.md, memory-banks.md to .mdx
- Use CodeSnippet to pull code from validated example scripts
- Add missing 'name' parameter to create_bank calls
- Fix main-methods.py entities iteration (dict not list)
- Remove retain-new.mdx demo file

* Migrate existing docs to match testing pattern with code snippet and add CLI tests to the CI

* Fix doc-id issue + add main-method tests

* CLI fixes

* Update openAPI json

* Fix rust build issues

* increase sleep time for Hindsight to process the document

* Added a polling sleep instead of fixed

* Delete immediately fails, so create the doc a earlier in the test to get the doc ready

* Add debug logs

* Remove debug logs
2025-12-19 12:17:59 -07:00
..
docs ci: finalize test for the documentation code (#57) 2025-12-19 12:17:59 -07:00
examples ci: finalize test for the documentation code (#57) 2025-12-19 12:17:59 -07:00
src Add documentation code validation system (#43) 2025-12-18 10:21:38 +01:00
static ci: finalize test for the documentation code (#57) 2025-12-19 12:17:59 -07:00
.gitignore rename to hindsight (#2) 2025-11-25 19:28:26 +01:00
docusaurus.config.ts Add Hindsight Cloud links to README and docs (#42) 2025-12-17 11:09:36 -05:00
openapi.json ci: finalize test for the documentation code (#57) 2025-12-19 12:17:59 -07:00
package.json Add documentation code validation system (#43) 2025-12-18 10:21:38 +01:00
README.md rename to hindsight (#2) 2025-11-25 19:28:26 +01:00
sidebars.ts fix: doc build and lint files (#34) 2025-12-16 13:49:09 +01:00
tsconfig.json rename to hindsight (#2) 2025-11-25 19:28:26 +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.