Skip to content

docs: v1.0.0 changelog, Memlake launch post, and version-1.0 docs snapshot - #5550

Merged
nicoloboschi merged 18 commits into
mainfrom
docs-changelog-1.0.0
Oct 13, 2026
Merged

nicoloboschi merged 18 commits into
mainfrom
docs-changelog-1.0.0

Conversation

@nicoloboschi

@nicoloboschi nicoloboschi commented Oct 13, 2026 •

Copy link
Copy Markdown
Collaborator

Docs for v1.0.0, now that the tag is cut (39c65ffe2, tag v1.0.0). Contains no version bumps — release.sh already made those on main.

What's in here

Memlake launch post — the 9 commits from vectorize-io/hindsight-private#1 (memlake-launch), cherry-picked onto main: hindsight-docs/blog/2026-10-13-memlake.md with its figures and light/dark SVGs, the sidebar entry, the featured-posts pin, and the announcement-bar link. The launch video (B-nAmMq3LB8) is embedded below the TL;DR, after <!-- truncate --> so no iframe lands in the blog-list excerpt; it reuses the responsive-iframe markup from the 40k-stars post rather than adding a component.

Cloud & Enterprise docs — new docs/cloud-enterprise/ section (overview, Hindsight Cloud, Enterprise with Memlake), also copied into the version-1.0 snapshot.

v1.0.0 changelog — generated with uv run --directory hindsight-dev generate-changelog 1.0.0 over v0.10.3..v1.0.0 (19 commits, 3 contributors).

  • No new migrations. 6ab9509eeb56 was the only one in the range, and the fix(api): consolidation discovery probe, mental-model edit race, LlamaParse v2 #5513 revert (65ef1bdee) deletes it, so 1.0.0 ships no schema change.
  • The tag-scoped rejection is filed under Breaking Changes rather than Bug Fixes, which is where the generator put it: it rejects calls that previously returned bank-wide results, and on a release whose own post says "the API is a promise" that belongs in the breaking section.

Two fixes that weren't just copying

A dead docs anchor. docs/developer/api/memory-banks.mdx links to /developer/configuration#bank-alias-cache, but configuration.mdx never documented HINDSIGHT_API_BANK_ALIAS_CACHE_TTL_SECONDS / _MAX_ENTRIES — the anchor did not exist and the build reported it broken. Both variables are real (config.py, .env.example), so this adds the missing Bank alias cache section instead of dropping the link. It would otherwise have been frozen into the 1.0 snapshot.

A version-1.0 collision. release.sh created its own 42-file version-1.0 snapshot on main; this branch already had a 45-file one (the 3 extra being the new cloud-enterprise/ pages). Merging main conflicted on developer/configuration.mdx and version-1.0-sidebars.json; both resolved to this branch's copies, and diff -r hindsight-docs/docs hindsight-docs/versioned_docs/version-1.0 is now clean.

Verification

cd hindsight-docs && npm run build — succeeds, no broken links and no broken anchors. Also eyeballed on a local dev server.

Note on main

Windows Smoke Test has been red since f843f173b. Not a product bug and not from this branch: hindsight-clients/python/tests/test_export_documents_wrapper.py:200 requires exactly one poll with timeout=0.05, and Windows' ~15 ms timer granularity lets two through (assert 2 == 1). Added in #5515, worth relaxing separately. Performance Tests has been red nightly for 10+ days, also pre-existing.

- blog/2026-10-08-memlake.md: 'Introducing Hindsight Memlake: serving 100M Memories at <100ms
  p99 on object storage', with figures, charts and cover
- featured: pin the Memlake post, unpin the 0.10.2 release post
- announcement bar: the post title, linking to the post
- custom.css: .post-wide for the post's wide figures
- Generated changelog entry for 1.0.0 (v0.10.3..main).
- Snapshot docs/ as versioned_docs/version-1.0/ and register 1.0 in
  versions.json, so 1.0 becomes the served docs version.
- Document HINDSIGHT_API_BANK_ALIAS_CACHE_TTL_SECONDS and
  _MAX_ENTRIES, which the memory-banks page already linked to but
  configuration.mdx never defined (dead anchor in the build).
- Regenerate the hindsight-docs agent skill.

No package/SDK version bumps: release.sh does those when the tag is cut.
Whitepaper publishes at https://vectorize.io/memlake/whitepaper; the
'architecture, guarantees and tradeoffs' link now points at the Enterprise
page's Memlake section, which this branch adds. Official star count is 49k.
All open questions resolved, so the review comments come out. The
quickstart placeholder now points at /developer/api/quickstart.
…e launch video

main reverted #5513, which removes its two changelog entries and the
6ab9509eeb56 migration — the release now ships no new migrations.

Also embeds the launch video (placeholder id) below the TL;DR, reusing the
iframe pattern from the 40k-stars post.
# Conflicts:
#	hindsight-docs/versioned_docs/version-1.0/developer/configuration.mdx
#	hindsight-docs/versioned_sidebars/version-1.0-sidebars.json
v1.0.0 is cut, so the entry is now generated from the real tag range
(v0.10.3..v1.0.0, 19 commits). Still no new migrations. The tag-scoped
rejection is filed under Breaking Changes: it rejects calls that used to
return bank-wide results.

Also syncs the docs skill's openapi.json to 1.0.0.
@nicoloboschi
nicoloboschi marked this pull request as ready for review October 13, 2026 14:44
scripts/docs_skill_figures.py --check-all requires every figure to render
as text for the docs skill, and the architecture diagram shipped with no
scenes. Adds one scene walking the API, the servers, the bucket and the
background jobs.
@nicoloboschi
nicoloboschi merged commit 610c135 into main Oct 13, 2026
99 checks passed
@nicoloboschi
nicoloboschi deleted the docs-changelog-1.0.0 branch October 13, 2026 14:55
@nicoloboschi nicoloboschi mentioned this pull request Nov 3, 2026
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.

1 participant