Skip to content

Commit dd8fc4f

Browse files
Link resolution (#467)
* docs(link-resolution): resolve link placeholders in CLI section - cli/overview.md: resolved Operations API and Configuration links - cli/commands.md: resolved Configuration link - cli/operations-api-commands.md: resolved all TODO links; mapped operations table category links to operations-api/operations.md with anchors (no sub-pages exist); resolved Applications → components/overview.md Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> * docs(link-resolution): resolve link placeholders in Fastify Routes, Studio, GraphQL Querying - fastify-routes/overview.md: resolved Resources and REST overview links - studio/overview.md: resolved configuration options and Operations API links - graphql-querying/overview.md: resolved schema definition, Resources, and Resource Query API links Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> * docs(link-resolution): resolve link placeholders in Env Vars, Static Files, HTTP, MQTT - environment-variables/overview.md: resolved Configuration and Components links - static-files/overview.md: resolved all Components overview links - http/overview.md: resolved REST Overview link - http/configuration.md: resolved Configuration Overview link - http/tls.md: resolved Operations API Configuration links (x2) - http/api.md: resolved Operations API and REST Overview links - mqtt/overview.md: resolved REST Overview link - mqtt/configuration.md: resolved Configuration Overview link Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> * docs(link-resolution): resolve link placeholders in Logging and Analytics - logging/configuration.md: resolved Configuration Overview link - logging/operations.md: resolved Operations API Overview link - analytics/overview.md: resolved Configuration Overview links (x2) - analytics/operations.md: resolved search_by_conditions and Operations API Overview links Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> * docs(link-resolution): resolve link placeholders in Security - security/overview.md: resolved Configuration Operations links (CORS network, TLS) - security/mtls-authentication.md: resolved Replication clustering link - security/certificate-verification.md: resolved Replication clustering link - security/certificate-management.md: resolved Replication clustering link Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> * docs(link-resolution): resolve link placeholders in REST, Components, Resources, Replication - rest/websockets.md: resolved Resource API and Resources overview links - rest/server-sent-events.md: resolved Resources overview link - components/overview.md: fixed malformed TODO-as-link-text for Resource API and Schema links - components/extension-api.md: resolved server global API link - components/plugin-api.md: resolved Resource API and server global API links - resources/overview.md: resolved REST Overview and MQTT Overview links - resources/query-optimization.md: resolved Schema documentation link - replication/overview.md: resolved Certificate Verification and Certificate Management links Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> * docs(link-resolution): resolve link placeholders in Database section - database/overview.md: resolved Resource API, Resources, Operations API, Configuration links - database/schema.md: resolved Operations API, Resources, Configuration links - database/api.md: resolved Resource API (x3) and Configuration links - database/data-loader.md: resolved Extension API and Components links - database/storage-algorithm.md: resolved Configuration links (x2) - database/jobs.md: resolved Operations API links (x2) - database/system-tables.md: resolved Replication clustering, Replication overview, Operations API links - database/compaction.md: resolved Configuration link - database/transaction.md: resolved Replication and Operations API links Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> * docs(link-resolution): resolve link placeholders in Operations API and Configuration - operations-api/overview.md: resolved Configuration Overview link - operations-api/operations.md: resolved SQL (→ database/sql.md) and Configuration links - configuration/operations.md: resolved restart and restart_service operation links Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> * docs(link-resolution): delete resolved link placeholder tracker files All link placeholders have been resolved. Removing tracker files now that link resolution is complete. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> * chore: update MEMORY.md — Part 3 link resolution complete Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> * fix(reference): resolve broken anchors in reference/v4 docs - security/overview: remove non-existent #network and #tls anchors from configuration/operations links - replication/overview: remove non-existent #operations-api anchor from clustering link - http/overview: fix server.http() anchor (#serverhttp → #serverhttplistener-options) - logging/api: fix logging.external anchor (#logging-external → #loggingexternal) - configuration/operations: fix restart_service anchor (#restart-service → #restart_service) - graphql-querying/overview: fix Resource Query API link (resources/overview#query → rest/querying) - components/applications: fix add_ssh_key anchor (#add-ssh-key → #add_ssh_key) - components/plugin-api: add explicit {#scopehandleentry} id to handleEntry heading - resources/overview: fix empty database/schema link Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> * update memory docs * format --------- Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com>
1 parent 4f3fa63 commit dd8fc4f

64 files changed

Lines changed: 394 additions & 1160 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

memory/MEMORY.md

Lines changed: 77 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,77 @@
1+
# Documentation Migration Memory
2+
3+
## Project Overview
4+
5+
Harper v4 docs migration: consolidating `versioned_docs/version-4.X/``reference_versioned_docs/version-v4/` with feature-based reorganization.
6+
7+
- **Working branch**: `major-version-reorg` (all migration PRs target this branch)
8+
- **Target dir**: `reference_versioned_docs/version-v4/`
9+
- **Do NOT touch**: `versioned_docs/` or `reference/`
10+
11+
## Key Files
12+
13+
- `v4-docs-implementation-plan.md` — Agent instructions (follow Part 1 closely)
14+
- `v4-docs-migration-map.md` — Authoritative source-to-target mapping per section
15+
- `v4-docs-reference-plan.md` — Structure philosophy and outline
16+
- `reference_versioned_sidebars/version-v4-sidebars.json` — Sidebar to update for each section
17+
- ~~`migration-context/link-placeholders/`~~**Deleted** (Part 3 link resolution complete)
18+
19+
## Release Notes Location
20+
21+
`release-notes/v4-tucker/4.X.0.md` (NOT `release_notes/`)
22+
23+
## Completed Sections
24+
25+
All Phase 1A–1D sections are complete and merged:
26+
27+
- CLI, GraphQL Querying, Studio, Fastify Routes (Phase 1A)
28+
- Environment Variables, Static Files, HTTP, MQTT, Logging, Analytics (Phase 1B)
29+
- Security, Users & Roles, REST (PR #457), Database (PR #458), Resources (PR #459), Components (PR #460), Replication (PR #461) (Phase 1C)
30+
- Operations API (PR #462), Configuration (PR #463) (Phase 1D)
31+
32+
## Key Decisions / Learnings
33+
34+
- Each section gets its own branch `migration/[section-name]` off `major-version-reorg` (for phase 1 content generation)
35+
- PRs are draft by default, opened against `major-version-reorg`
36+
- `@relationship` in v4.7 source (not `@relation` from 4.3 release notes) — needs human verification
37+
- Audit log required for real-time messaging (MQTT/WebSocket) — verify still true
38+
- `schema.md` kept unified (overview + blobs + vectors); consider splitting if too long
39+
- System tables include: `hdb_raw_analytics`, `hdb_analytics`, `hdb_dataloader_hash`, `hdb_nodes`, `hdb_certificate`
40+
- Analytics detail lives in `analytics/overview.md`, not `database/system-tables.md`
41+
- Components section added `javascript-environment.md` (not in original plan)
42+
43+
## Next Steps
44+
45+
**Part 3 (Link Resolution) — Complete** on `link-resolution` branch (10 commits). Merge to `major-version-reorg` via PR review, then continue:
46+
47+
**Part 4 (Cross-Reference Updates)** — Full plan in [`memory/part4-plan.md`](part4-plan.md).
48+
49+
- Branch: `cross-reference-updates` off `major-version-reorg`
50+
- Scope: ~7 release note files + 1 learn guide with old `/docs/` links
51+
- **First step**: verify URL prefix for new reference pages (check `docusaurus.config.js`)
52+
53+
**Part 5 (Redirects)** — Configure redirects from old paths (`/docs/reference/`, `/docs/developers/`, etc.) to new paths in `docusaurus.config.js`.
54+
55+
### Part 3 Key Decisions
56+
57+
- Operations table category links (e.g. `../operations-api/database.md`) → `../operations-api/operations.md` with section anchors (no sub-pages exist)
58+
- `resources/global-apis.md` never created → links redirected to `../components/javascript-environment.md`
59+
- SQL operations link → `../database/sql.md` (SQL moved from legacy per migration map)
60+
- `[Applications](TODO:applications/overview.md)``../components/overview.md`
61+
- Malformed `[TODO:path](TODO:path)` links in `components/overview.md` fixed with proper text
62+
63+
Legacy section: single files only (no subfolders): `cloud.md`, `custom-functions.md`. SQL moved to `database/sql.md`.
64+
65+
## Sidebar Pattern
66+
67+
```json
68+
{
69+
"type": "category",
70+
"label": "Section Name",
71+
"collapsible": false,
72+
"className": "learn-category-header",
73+
"items": [{ "type": "doc", "id": "section/page", "label": "Label" }]
74+
}
75+
```
76+
77+
Insert new sections before the Legacy category at the bottom of the sidebar.

memory/part4-plan.md

Lines changed: 143 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,143 @@
1+
# Part 4: Cross-Reference Updates — Plan & Procedure
2+
3+
## Overview
4+
5+
Update links in `release-notes/` and `learn/` that point to old doc paths, mapping them to the new `reference_versioned_docs/version-v4/` structure.
6+
7+
**Branch**: Create a new branch `cross-reference-updates` off `major-version-reorg` (after `link-resolution` is merged).
8+
9+
**Commit strategy**: One commit per file group (release notes in one commit, learn guides in another, or broken down further if large).
10+
11+
---
12+
13+
## Scope of Changes
14+
15+
### Release Notes (`release-notes/v4-tucker/`)
16+
17+
171 files total. Only ~7 files have `/docs/` links that need updating. The full list of unique links found (grep: `(/docs/[^)"\ ]*)` across all `release-notes/v4-tucker/*.md`):
18+
19+
| Old Path | New Path | Notes |
20+
| ------------------------------------------------------------------------------------- | ------------------------------------------------------------ | --------------------------------------------------- |
21+
| `/docs/deployments/configuration` | `/docs/v4/configuration/overview` | 7 occurrences |
22+
| `/docs/reference/resources` | `/docs/v4/resources/overview` | 4 occurrences |
23+
| `/docs/developers/applications/defining-schemas` | `/docs/v4/database/schema` | 4 occurrences |
24+
| `/docs/reference/graphql` | `/docs/v4/graphql-querying/overview` | 1 occurrence |
25+
| `/docs/reference/components/extensions` | `/docs/v4/components/extension-api` | 1 occurrence |
26+
| `/docs/reference/components/applications?_highlight=github#adding-components-to-root` | `/docs/v4/components/applications#adding-components-to-root` | 1 occurrence |
27+
| `/docs/reference/blob` | `/docs/v4/database/schema#blob-storage` | 1 occurrence |
28+
| `/docs/developers/rest` | `/docs/v4/rest/overview` | 1 occurrence |
29+
| `/docs/developers/replication/sharding` | `/docs/v4/replication/sharding` | 1 occurrence |
30+
| `/docs/developers/replication/` | `/docs/v4/replication/overview` | 1 occurrence |
31+
| `/docs/developers/real-time` | `/docs/v4/rest/websockets` | 1 occurrence (real-time = websockets+SSE+MQTT) |
32+
| `/docs/developers/operations-api/clustering` | `/docs/v4/replication/clustering` | 1 occurrence |
33+
| `/docs/developers/applications/data-loader` | `/docs/v4/database/data-loader` | 1 occurrence |
34+
| `/docs/deployments/harper-cli` | `/docs/v4/cli/overview` | 1 occurrence |
35+
| `/docs/administration/logging/` | `/docs/v4/logging/overview` | 1 occurrence |
36+
| `/docs/administration/cloning` | N/A — learn guide (not in reference) | Leave or link to learn guide if exists |
37+
| `/docs/4.1/custom-functions/host-static` | `/docs/v4/legacy/custom-functions` | Legacy redirect |
38+
| `/docs/4.1/configuration#storage` | `/docs/v4/configuration/options#storage` | 1 occurrence |
39+
| `/docs/4.1/configuration#session-affinity` | `/docs/v4/configuration/options#http` | 1 occurrence (http section covers session affinity) |
40+
| `/docs/4.1/configuration#schemas` | `/docs/v4/database/schema` | 1 occurrence |
41+
42+
> **NOTE**: The exact URL prefix for the new structure (`/docs/v4/`) needs to be verified. Check `docusaurus.config.js` or `reference_versioned_sidebars/version-v4-sidebars.json` for the versioned path prefix. It may be `/docs/v4/` or `/reference/v4/` or similar.
43+
44+
**Files that contain links (to edit):**
45+
46+
- `release-notes/v4-tucker/4.1.0.md``/docs/4.1/configuration#*` and `/docs/4.1/custom-functions/*`
47+
- `release-notes/v4-tucker/4.2.0.md``/docs/reference/resources`, `/docs/reference/components/*`
48+
- `release-notes/v4-tucker/4.3.0.md``/docs/reference/resources`
49+
- `release-notes/v4-tucker/4.4.0.md``/docs/developers/applications/defining-schemas`, `/docs/reference/resources`, `/docs/reference/graphql`
50+
- `release-notes/v4-tucker/4.5.0.md``/docs/reference/blob`, `/docs/deployments/configuration`
51+
52+
**To find all affected files precisely**: `grep -rl "/docs/" release-notes/v4-tucker/`
53+
54+
---
55+
56+
### Learn Guides (`learn/`)
57+
58+
Only 4 content files currently exist (most are stubs):
59+
60+
- `learn/developers/harper-applications-in-depth.mdx`
61+
- `learn/getting-started/create-your-first-application.mdx`
62+
- `learn/getting-started/install-and-connect-harper.mdx`
63+
- `learn/index.mdx`
64+
65+
Links found in `harper-applications-in-depth.mdx`:
66+
67+
| Old Path | New Path |
68+
| ------------------------------------------------ | ------------------------------------------------------------ |
69+
| `/docs/reference/components/built-in-extensions` | `/docs/v4/components/overview#built-in-extensions-reference` |
70+
| `/docs/reference/resources` | `/docs/v4/resources/overview` |
71+
| `/docs/reference/globals#logger` | `/docs/v4/logging/api` |
72+
| `/docs/reference/resources/` | `/docs/v4/resources/overview` |
73+
| `/docs/reference/components/` | `/docs/v4/components/overview` |
74+
75+
---
76+
77+
## Procedure
78+
79+
### Step 1: Verify URL prefix
80+
81+
Before editing any links, confirm what the new URL prefix is for `reference_versioned_docs/version-v4/`. Check:
82+
83+
```bash
84+
cat docusaurus.config.js | grep -A5 "reference_versioned"
85+
# or
86+
cat reference_versioned_sidebars/version-v4-sidebars.json | head -5
87+
```
88+
89+
The prefix is likely `/docs/v4/` but confirm before proceeding.
90+
91+
### Step 2: Find all affected release note files
92+
93+
```bash
94+
grep -rl "/docs/" release-notes/v4-tucker/
95+
```
96+
97+
This gives the exact list of files to edit.
98+
99+
### Step 3: Edit release notes
100+
101+
For each affected file, replace old `/docs/` paths with new `/docs/v4/` paths per the mapping table above.
102+
103+
### Step 4: Edit learn guides
104+
105+
Read each of the 4 learn guide files, apply the mapping table above.
106+
107+
### Step 5: Check for any remaining old-path links across the whole repo
108+
109+
```bash
110+
grep -rn "/docs/reference/" --include="*.md" --include="*.mdx" release-notes/ learn/
111+
grep -rn "/docs/developers/" --include="*.md" --include="*.mdx" release-notes/ learn/
112+
grep -rn "/docs/deployments/" --include="*.md" --include="*.mdx" release-notes/ learn/
113+
grep -rn "/docs/administration/" --include="*.md" --include="*.mdx" release-notes/ learn/
114+
grep -rn "/docs/4\." --include="*.md" --include="*.mdx" release-notes/ learn/
115+
```
116+
117+
### Step 6: Commit
118+
119+
- Commit release notes changes: `docs(cross-refs): update old /docs/ links in release notes to v4 reference paths`
120+
- Commit learn guide changes: `docs(cross-refs): update old /docs/ links in learn guides to v4 reference paths`
121+
122+
---
123+
124+
## Key Uncertainties to Resolve
125+
126+
1. **URL prefix** — Confirm whether new reference pages are served at `/docs/v4/`, `/reference/v4/`, or another prefix. **Critical before editing any links.**
127+
2. **`/docs/administration/cloning`** — This was flagged in migration map as "move to Learn guide." If no learn guide exists yet, either leave as-is (broken link) or remove the link text.
128+
3. **`/docs/developers/real-time`** — This page covered WebSockets, SSE, and MQTT. Best split into: WebSockets content → `rest/websockets`, MQTT content → `mqtt/overview`. In context of release notes, pick whichever is most relevant to the surrounding text.
129+
130+
---
131+
132+
## Non-Goals for Part 4
133+
134+
- Do NOT edit `versioned_docs/` files
135+
- Do NOT edit `reference_versioned_docs/` files (those were handled in Part 3)
136+
- Do NOT update links in the v1/v2/v3 release notes (out of scope)
137+
- Do NOT update links in other config files (docusaurus.config.js, sidebars, etc.) — that's Part 5
138+
139+
---
140+
141+
## After Part 4
142+
143+
Proceed to **Part 5: Redirects** — configure redirects from old `/docs/developers/`, `/docs/reference/`, etc. paths to the new `/docs/v4/` equivalents in `docusaurus.config.js` (or wherever redirects are configured).

migration-context/link-placeholders/analytics-link-placeholders.md

Lines changed: 0 additions & 26 deletions
This file was deleted.

0 commit comments

Comments
 (0)