Skip to content

CORE-1825 Add/Update "install harpedb" subtopics#1

Merged
DavidCockerill merged 12 commits into
CORE-1824from
CORE-1825
Oct 28, 2022
Merged

CORE-1825 Add/Update "install harpedb" subtopics#1
DavidCockerill merged 12 commits into
CORE-1824from
CORE-1825

Conversation

@terraHDB

@terraHDB terraHDB commented Sep 23, 2022

Copy link
Copy Markdown
Contributor

This PR is mainly migrating the docs as they existed previous to 4.0.0, but in markdown to be used in gitBook. There is a lot to migrate so I'm sectioning the work into smaller portions for easier review.

Under "Install HarperDB" I've added mac, windows, node version requirements and offline instructions.

Current state of Install HarperDB docs: https://harperdb.io/docs/install-harperdb/

Comment thread docs/install-harperdb/node-ver-requirement.md
Comment thread docs/install-harperdb/mac.md
Comment thread docs/install-harperdb/windows.md Outdated
Comment thread docs/install-harperdb/offline.md Outdated
Comment thread docs/install-harperdb/mac.md Outdated
Comment thread docs/install-harperdb/node-ver-requirement.md Outdated
Comment thread docs/install-harperdb/windows.md Outdated
Comment thread docs/install-harperdb/node-ver-requirement.md Outdated
Comment thread docs/install-harperdb/offline.md Outdated
Comment thread docs/install-harperdb/windows.md Outdated
@terraHDB
terraHDB changed the base branch from main to CORE-1824 September 26, 2022 15:29
Comment thread docs/install-harperdb/mac.md Outdated
Update installation for other operating systems.
@DavidCockerill
DavidCockerill merged commit 223284b into CORE-1824 Oct 28, 2022
DavidCockerill pushed a commit that referenced this pull request Nov 15, 2022
* doc migration epic branch

* 3/4 progress of security

* finished configuration.md, began users and roles

* users and roles migrated; still needs updates

* updated user and roles operations

* corrections to security docs

* CORE-1825 Add/Update "install harpedb" subtopics (#1)

* added mac, added/updated windows, added/updated node version requirements, and added offline docs

* go requirements

* docs adjustments

* testing variable usage

* testing variable usage

* Update other.md

Update installation for other operating systems.

* added link to download

* node version

* exact replica download button

* functional download link

* deleted old link

* node version

Co-authored-by: Kris Zyp <kriszyp@gmail.com>

* Core 1826 add/update harperdb studio topic and subtopics (#2)

* added mac, added/updated windows, added/updated node version requirements, and added offline docs

* 1/3 through studio subtopics

* 2/3 through studio subtopics

* 3/3 through studio subtopics

* corrected harperdb operations api

* removed icon descriptions and fixed typos

* removed icon descriptions

* primary key vs hash_attribute change

* primary key vs hash attribute qualifier

* minor change to example function

Co-authored-by: Kris Zyp <kriszyp@gmail.com>
DavidCockerill pushed a commit that referenced this pull request Nov 29, 2022
* testing variable syntax

* testing variable syntax

* testing variable syntax

* testing variable syntax

* testing variable syntax

* testing variable syntax

* testing variable syntax

* testing variable syntax

* testing variable syntax

* testing variable syntax

* testing variable syntax

* testing variable syntax

* testing variable syntax

* testing variable syntax

* testing variable syntax

* testing variable syntax

* reverted changes from variable testing

* added diagrams and clustering docs

* more formatting

* formatted the rest of clustering docs

* Core 1828 Docs Migration- Security: Topic and Subtopics (#4)

* doc migration epic branch

* 3/4 progress of security

* finished configuration.md, began users and roles

* users and roles migrated; still needs updates

* updated user and roles operations

* corrections to security docs

* CORE-1825 Add/Update "install harpedb" subtopics (#1)

* added mac, added/updated windows, added/updated node version requirements, and added offline docs

* go requirements

* docs adjustments

* testing variable usage

* testing variable usage

* Update other.md

Update installation for other operating systems.

* added link to download

* node version

* exact replica download button

* functional download link

* deleted old link

* node version

Co-authored-by: Kris Zyp <kriszyp@gmail.com>

* Core 1826 add/update harperdb studio topic and subtopics (#2)

* added mac, added/updated windows, added/updated node version requirements, and added offline docs

* 1/3 through studio subtopics

* 2/3 through studio subtopics

* 3/3 through studio subtopics

* corrected harperdb operations api

* removed icon descriptions and fixed typos

* removed icon descriptions

* primary key vs hash_attribute change

* primary key vs hash attribute qualifier

* minor change to example function

Co-authored-by: Kris Zyp <kriszyp@gmail.com>

* added more context to clustering intro page; adjusted subscription behavior description

Co-authored-by: Kris Zyp <kriszyp@gmail.com>
@Ethan-Arrowood
Ethan-Arrowood deleted the CORE-1825 branch August 12, 2025 17:20
kylebernhardy pushed a commit that referenced this pull request Jul 4, 2026
The live primary-key question exposed thin grounding — chat was fed page-head
truncations, not the section that matched. Two levers, measured by a new eval.

- Retrieval: chat now calls runSearch with blend:true (equal-weight RRF so the
  semantic lane counts for NL questions) and withText:true (the matched section
  text). Both options are opt-in — the search box stays keyword-primary and
  byte-identical (search-eval still MRR 0.907 / Recall@5 100%).
- retrieveOnly mode on POST /api/chat: returns grounding sources without
  generating — no LLM cost, no quota. Powers a grounding preview + the eval.
- eval/chat-grounding.json + scripts/chat-grounding.ts (npm run chat-eval):
  NL questions → expected doc-page substrings, scored Recall@5 / MRR. Baseline
  Recall@5 75%, MRR 0.75 (9/12 at rank #1). CI gates --min-recall 0.6.

Result: the primary-key question that refused before now answers correctly with
the @table/@PrimaryKey syntax, cited. Remaining eval misses (blob, Fabric
deploy, TypeScript) are the next targets. Suite: 38 green.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01Eijma5uKcPZi9tqV2aJBeh
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.

4 participants