Use canonical docs links and refresh quickstart in org profile by xav-db · Pull Request #2 · HelixDB/.github · GitHub
Skip to content

Use canonical docs links and refresh quickstart in org profile - #2

Open
xav-db wants to merge 1 commit into
mainfrom
codex/profile-readme-readability
Open

xav-db wants to merge 1 commit into
mainfrom
codex/profile-readme-readability

Conversation

@xav-db

@xav-db xav-db commented Sep 28, 2026

Copy link
Copy Markdown
Member

Tightens the org profile: every docs deep link now points at its canonical page, and the quickstart details match the current CLI. The hero, 3-column table, and section layout are unchanged.

- Knowledge graphs, vectors, full-text search, and transactional application data in one Rust engine — built for agents, GraphRAG, and company brains.
+ Open-source graph database with native vector and full-text search, built on object storage.

- [Get started](…/cli/getting-started)
+ [Get started](…/database/helix-db/start-here/quickstart) · [Learning center](…/learn)

  curl -sSL "https://install.helix-db.com" | bash
+ # On Windows (PowerShell), run this instead:
+ # irm https://raw.githubusercontent.com/HelixDB/helix-db/main/crates/cli/install.ps1 | iex

- hand the build to Codex, Claude Code, or OpenCode.
+ hand the build to Claude Code, OpenAI Codex, OpenCode, or Cursor Agent.

- …/database/{rust,typescript,go,python}-project-setup
+ …/database/helix-db/start-here/sdk-setup/{rust,typescript,go,python}-project-setup
- [Querying guide](…/database/querying-guide/overview)
+ [Query walkthrough](…/database/helix-db/core-concepts/overview)
- …/database/architecture
+ …/database/helix-cloud/start-here/architecture
  • Canonical links: the old SDK, querying, and architecture paths returned 308 redirects. They now point straight at the destination pages.
  • Get started: now goes to the quickstart, which is the same entry point the helix-db README uses.
  • Windows: the PowerShell install command now sits next to the macOS/Linux one. It is commented out, so copying the whole block still works in bash.
  • Agents: the list now matches the order helix chef detects them in (AGENT_PRIORITY in crates/cli/src/commands/chef.rs).
  • Tagline: one line matching the proposed org description below. The Learning center link was added to the header nav.

Manual follow-ups (org settings)

These are org settings, so a PR can't change them:

  • Set the org description to: "Open-source graph database with native vector and full-text search, built on object storage." The current description uses a superlative and doesn't mention full-text search.
  • Pin the skills repo next to helix-db.
  • Relabel or make private the public forks slatedb, cmem, and graphify-v8. Their upstream descriptions and homepages make them look like Helix products.
  • Archive hql-v1-docs.
  • Give skills a real description and homepage.

Testing

  • Links checked with curl -s -o /dev/null -w "%{http_code}". All docs deep links, GitHub, install scripts, logos, and badges return 200.
  • Three links still redirect, and that's intended: the docs.helix-db.com root goes to the docs home, helix-db.com goes to www, and discord.gg goes to discord.com.

…tails

Replace redirected SDK, querying, and architecture links with their
canonical docs URLs, send Get started to the quickstart, add the
Learning center link and the Windows install command, list the agents
helix chef launches in priority order, and use a one-line tagline.
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