Commit d895f42
docs(reference): use harper-config.yaml consistently in v5 (#661)
* docs(reference): use harper-config.yaml consistently in v5
The v5 docs used both `harper-config.yaml` and the pre-v5
`harperdb-config.yaml`. Two pages contradicted each other outright:
`resources/resource-api.md` told readers to set
`authentication.enableSessions` in `harperdb-config.yaml` while
`security/jwt-authentication.md` put the sibling `authentication` token
timeouts in `harper-config.yaml`.
`harper-config.yaml` is the correct name. In HarperFast/harper,
`utility/hdbTerms.ts` labels `HDB_CONFIG_FILE` ('harperdb-config.yaml')
"Old Harper Root Config File" and `HARPER_CONFIG_FILE`
('harper-config.yaml') "Harper Root Config File". Every resolver prefers
the new name and falls back to the old one only when the new file is
absent (`config/configUtils.ts` getConfigFilePath and setConfigValue,
`bin/run.ts`, `utility/logging/harper_logger.ts`), and all writes target
the new name (`configUtils.ts` initial write, `installer.ts` boot-props
`settings_path`, and `<timestamp>-harper-config.yaml.bak` backups).
Replaces the five remaining occurrences in `reference/`, plus one in
`release-notes/v5-lincoln/v5-migration.md` that described current v5
module-loading behavior with the legacy name. `reference_versioned_docs/version-v4/`
is left alone, as is the 5.0 release note that documents the rename itself.
Also adds a note to `reference/configuration/overview.md`: with the legacy
spelling gone from every other v5 page, an instance upgraded from v4 that
still has `harperdb-config.yaml` on disk had no signal anywhere in the v5
docs. The note states the loader's actual behavior, including that
upgrading does not rename the file.
This fixes a docs-side bug that propagates into HarperFast/skills, which
generates agent-facing rules from these pages. The `checking-authentication`
rule (HarperFast/skills#81) pulled both sections into one rule, so it tells
agents to set `enableSessions` in `harperdb-config.yaml` in one step and
`operationTokenTimeout` in `harper-config.yaml` in another.
Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
* docs(configuration): anchor the upgraded-instance note on settings_path
The note claimed Harper looks for `harper-config.yaml` first and falls
back to `harperdb-config.yaml`, then writes later changes back to
whichever file it found. That describes only the root-path override path.
`configUtils.ts` getConfigFilePath does the new-name-first lookup inside
`if (cmdArgs)`, where `cmdArgs` is `getEnvCliRootPath()` — a `ROOTPATH`
environment variable or `--ROOTPATH` argument. With neither set, which is
the normal installed case, it returns the literal `settings_path` from the
boot properties file. `installer.ts` writes `settings_path` only on a fresh
install (it exits early when either config file already exists), and
nothing in `upgrade/` repoints it, so an upgraded node keeps naming
`harperdb-config.yaml`. Renaming the file therefore breaks startup rather
than migrating it, and because setConfigValue resolves the file by its own
directory lookup that prefers the new name, leaving both files present can
send startup and configuration writes to different files.
Rewrites the note around `settings_path` as the thing that actually
selects the file, and drops the precedence claim.
Reported by @kriszyp in review.
Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
---------
Co-authored-by: Claude Opus 5 <noreply@anthropic.com>1 parent c832245 commit d895f42
6 files changed
Lines changed: 10 additions & 6 deletions
File tree
- reference
- configuration
- mcp
- resources
- release-notes/v5-lincoln
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
9 | 9 | | |
10 | 10 | | |
11 | 11 | | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
| 15 | + | |
12 | 16 | | |
13 | 17 | | |
14 | 18 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
31 | 31 | | |
32 | 32 | | |
33 | 33 | | |
34 | | - | |
| 34 | + | |
35 | 35 | | |
36 | 36 | | |
37 | 37 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
6 | 6 | | |
7 | 7 | | |
8 | 8 | | |
9 | | - | |
| 9 | + | |
10 | 10 | | |
11 | 11 | | |
12 | 12 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
23 | 23 | | |
24 | 24 | | |
25 | 25 | | |
26 | | - | |
| 26 | + | |
27 | 27 | | |
28 | 28 | | |
29 | 29 | | |
30 | 30 | | |
31 | 31 | | |
32 | | - | |
| 32 | + | |
33 | 33 | | |
34 | 34 | | |
35 | 35 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
745 | 745 | | |
746 | 746 | | |
747 | 747 | | |
748 | | - | |
| 748 | + | |
749 | 749 | | |
750 | 750 | | |
751 | 751 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
120 | 120 | | |
121 | 121 | | |
122 | 122 | | |
123 | | - | |
| 123 | + | |
124 | 124 | | |
125 | 125 | | |
126 | 126 | | |
| |||
0 commit comments