Skip to content

Engram docs#345

Open
g-despot wants to merge 36 commits into
mainfrom
engram
Open

Engram docs#345
g-despot wants to merge 36 commits into
mainfrom
engram

Conversation

@g-despot
Copy link
Copy Markdown
Contributor

What's being changed:

  • Add Engram documentation: introduction, quickstart, concepts, guides (store, search, manage, run status), and API reference
  • Integrate interactive API reference via Scalar + OpenAPI spec
  • Add Engram to secondary navbar and sidebar

New pages

All under docs/engram/: introduction, quickstart, core concepts (memories, topics, groups, scoping, pipelines, runs), four how-to guides, and an API reference overview linking to the interactive Scalar reference at /engram/api-reference/rest.

Config changes

  • sidebars.jsengramSidebar
  • secondaryNavbar.js — Engram nav entry
  • docusaurus.config.js — Scalar plugin instance for Engram OpenAPI spec
  • static/specs/engram-openapi.json — Generated OpenAPI spec (user-facing endpoints only)

Type of change:

  • Documentation content updates (non-breaking change to fix/update documentation )
  • Bug fix (non-breaking change to fixes an issue with the site)
  • Feature or enhancements (non-breaking change to add functionality)

How has this been tested?

  • Local build - the site works as expected when running yarn start

Copy link
Copy Markdown

@orca-security-eu orca-security-eu Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Orca Security Scan Summary

Status Check Issues by priority
Passed Passed Infrastructure as Code high 0   medium 0   low 0   info 0 View in Orca
Passed Passed SAST high 0   medium 0   low 0   info 0 View in Orca
Passed Passed Secrets high 0   medium 0   low 0   info 0 View in Orca
Passed Passed Vulnerabilities high 0   medium 0   low 0   info 0 View in Orca

@g-despot g-despot changed the title Add initial docs Engram docs Feb 13, 2026
Comment thread docs/engram/_includes/quickstart.py Outdated
Comment thread docs/engram/_includes/quickstart.py Outdated
Comment thread docs/engram/quickstart.md Outdated
Comment thread docs/engram/_includes/quickstart.py Outdated
Comment thread docs/engram/concepts/pipelines.md Outdated
Comment thread docs/engram/guides/store-memories.md Outdated
Comment thread docs/engram/_includes/store_memories.py Outdated
Comment thread docs/engram/guides/check-run-status.md Outdated
Comment thread docs/engram/tutorials/memory-chat-app.md
Comment thread docs/engram/tutorials/context-window-management.md
Comment thread docs/engram/concepts/groups.md Outdated
Comment thread docs/engram/concepts/scopes.md Outdated
Comment thread docs/engram/concepts/scopes.md Outdated
Comment thread docs/engram/concepts/scopes.md Outdated
Comment thread docs/engram/concepts/scopes.md
Comment thread docs/engram/concepts/input-data-types.md Outdated
Copy link
Copy Markdown
Member

@CShorten CShorten left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looking awesome, really loved reading this! 🔥

Comment thread docs/engram/_includes/search_memories.py
Comment thread docs/engram/_includes/check_run_status.py Outdated
Comment thread docs/engram/index.md Outdated
Comment thread docs/engram/concepts/scopes.md Outdated
Comment thread docs/engram/concepts/scopes.md Outdated
Copy link
Copy Markdown

@danmichaeljones danmichaeljones left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry for the long list of comments! Overall I love how these docs look, the flow etc is really clear 👍 Below are mostly small details

Comment thread docs/engram/_includes/architecture.png
Comment thread docs/engram/quickstart.md Outdated
Comment thread docs/engram/quickstart.md Outdated
Comment thread docs/engram/concepts/index.md Outdated
Comment thread docs/engram/_includes/concepts.png
Comment thread docs/engram/concepts/groups.md Outdated
Comment thread docs/engram/guides/store-memories.md Outdated
Comment thread docs/engram/guides/store-memories.md Outdated
Comment thread docs/engram/guides/store-memories.md Outdated
Comment thread docs/engram/guides/check-run-status.md Outdated
Comment thread docs/engram/guides/search-memories.md
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants