mirror of
https://github.com/hanzoai/insights.git
synced 2026-10-30 16:15:31 +00:00
The tree was a debranded snapshot of upstream taken around 2026-02-20, and upstream has moved about five months since. This replaces it with upstream master, mechanically re-derived: bin/debrand does the rename, and the pipeline and squashed migrations are restored from the shipped tree. Not a merge. The previous import replaced the tree wholesale in a single commit, so there is no shared content history to merge against. Reproducing the rename on the new tree is what actually converges. What survives: .hanzo/workflows, the Dockerfiles and bin/docker* entrypoints, compose files, LLM.md, and insights/migrations. The squashed initial migration is load-bearing — the live database records it by name, so upstream's ~918 individual migrations cannot come back. Nine products are dropped as unreferenced. Twenty-one more that we do not run are kept anyway because the core app still imports them; unpicking those is a refactor and does not belong in a rebase. This base does not build yet, and the reasons are not in the rename: upstream now wants Python 3.13.13 against our 3.12.12 and Django 5.2 against our 4.2, and the dependency manifests still name upstream packages that we republish under our own names. Those are decisions, not renames.
1.6 KiB
1.6 KiB
Insights Documentation
Developer-focused documentation alongside code. Update docs in the same PR as your code changes.
Structure
published/ - Published on hanzo.ai
Documentation published when merged to master. The URL mirrors the directory structure - just strip the docs/published/ prefix:
docs/published/docs/surveys/... → hanzo.ai/docs/surveys/...
docs/published/handbook/engineering/... → hanzo.ai/handbook/engineering/...
Examples:
published/docs/surveys/sdk-feature-support.md→/docs/surveys/sdk-feature-supportpublished/handbook/engineering/developing-locally.md→/handbook/engineering/developing-locally
internal/ - GitHub-only
Documentation that stays in the repository:
- Development workflows
- Migration patterns
- Team processes
When to use: Knowledge useful for the team but not for external users. We're open source, so "internal" means GitHub-only rather than truly private.
Publishing Flow
Engineer creates PR with /docs/published/** changes
↓
GitHub Action triggers hanzo.ai preview build
↓
Preview URL posted to PR
↓
Merge to master
↓
Docs go live on hanzo.ai
The hanzo.ai Gatsby build uses gatsby-source-git to clone this monorepo and pull files from /docs/published/ during the build process.
Guidelines
- All published docs must have YAML frontmatter
- Use relative links between docs:
../contributing/index.md - Docs about Insights internals → here
- User product docs and tutorials → hanzo.ai repo
Setup
For hanzo.ai team setting up the integration, see the PRs in Insights/hanzo.ai repo.