Visitar URL original
GitHub - humemai/humemai-docs: Source of docs.humem.ai · GitHub
Skip to content

About

Source of docs.humem.ai

Resources

Stars

0 stars

Watchers

0 watching

Forks

Repository files navigation

humemai-docs

Shared documentation hub for published HumemAI project docs.

Current doc sets, each with a card on the landing page:

  • mmdbbench/
  • audit-ready-memory/
  • tiervec/: experimental and unreleased. It has one version, dev, which follows main of humemai/tiervec; there is no latest until a release. Its pages are at https://docs.humem.ai/tiervec/dev/<page>/, and the card links https://docs.humem.ai/tiervec/dev/.

External cards (no folder here): "ArcadeDB" links the engine manual, https://docs.arcadedb.com/arcadedb/, and "ArcadeDB in Python" links the Python package's docs, https://docs.arcadedb.com/arcadedb-python/. The two names match the two research pages and the two software pages on humem.ai.

Unlisted (no card, files kept so existing links and the packages' own links keep working): dbbench/, the docs of MMDBBench under its old name (renamed 2026-11-07; its root index.html redirects to /mmdbbench/, the pages under dbbench/latest/ stay as published), humemdb/ and cypherglot/, paused projects, hidden from the landing page on 2026-10-19 as on humem.ai.

Retired and removed: arcadedb/, the docs of the old arcadedb-embedded package. Since 2026-10-29 every path under docs.humem.ai/arcadedb (root, latest and the version folders) answers with a 301 to https://docs.arcadedb.com/arcadedb-python/ through a Cloudflare Single Redirect rule on the humem.ai zone (302 for the first hours). The folder was deleted the same day because no path under it could be reached any more; it is in the git history before that commit.

The landing page (index.html) takes its colours, type, logo and favicon from the HumemAI design system, vendored into brand/ from humemai/design-system (brand/verify.sh checks the copy). Each doc set's own theme is vendored in its source repo, under docs/brand.

Versions published before the design system (up to arcadedb 26.9.1, humemdb 0.1.0.dev4, cypherglot 0.1.0 and audit-ready-memory 0.0.2) were restyled in place on 2026-09-27 with the design system's scripts/restyle-built-mkdocs.py: theme only, page text unchanged. favicon.ico at the root answers browsers that ask for it on any page.

How the hub is written

Each project's own repository builds its docs, and its deploy workflow pushes them here with mike under <project>/<version>/ and an alias latest; the bot commits read "Deployed to in ". The project folders are written by those workflows: do not edit or delete them by hand (the restyle script above is the one exception, for old versions). What is edited by hand is index.html, README.md, favicon.ico, CNAME and, through the design system, brand/.

  • A link to a doc page needs the version segment: https://docs.humem.ai/<project>/latest/<page>/ works and https://docs.humem.ai/<project>/<page>/ is a 404. Only the project root https://docs.humem.ai/<project>/ redirects.
  • To add, remove, hide or show a project, change its landing card in index.html and the lists above in the same pull request: every folder is either listed with a card or named as unlisted. A new project's deploy workflow can be copied from humemai/mmdbbench and needs the HUMEMAI_DOCS_TOKEN secret.
  • The bots push to main at any time: pull with rebase before you push, and never force-push.
  • The only CI here is .github/workflows/brand.yml: it runs brand/verify.sh on a change to brand/, so a hand edit of the vendored copy fails. Before you merge, open index.html in a browser at a wide desktop width and a phone width, in light and dark mode, and run brand/verify.sh.

About

Source of docs.humem.ai

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages