Docs -> Reference (Major version consolidation) Base#436
Draft
Ethan-Arrowood wants to merge 16 commits intomainfrom
Draft
Docs -> Reference (Major version consolidation) Base#436Ethan-Arrowood wants to merge 16 commits intomainfrom
Ethan-Arrowood wants to merge 16 commits intomainfrom
Conversation
Ethan-Arrowood
changed the title
Ethan-Arrowood
force-pushed
the
major-version-reorg
branch
2 times, most recently
from
f64304b to
c8fd63c
Compare
Ethan-Arrowood
force-pushed
the
major-version-reorg
branch
from
c8fd63c to
78eca4b
Compare
Ethan-Arrowood
changed the title
- Temporarily disable local search plugin (will re-enable later) - Set onBrokenLinks to 'warn' to allow build during migration - Add /reference redirect page to handle versioned docs structure - Create index.md files for reference directories - Update sidebars to autogenerate from directory structure - Document temporary changes in project brief for future re-enablement The site now builds successfully and is ready for migration PRs. Broken link warnings are expected as content is migrated. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
🚀 Preview DeploymentYour preview deployment is ready! 🔗 Preview URL: https://preview.harper-docs.stage.harperfabric.com/pr-436 This preview will update automatically when you push new commits. |
* docs: migrate CLI section to v4 consolidated reference Migrated Harper CLI documentation from versioned_docs to new reference_versioned_docs/version-v4/cli/ structure following the v4 documentation consolidation plan. Files created: - reference_versioned_docs/version-v4/cli/overview.md - reference_versioned_docs/version-v4/cli/commands.md - reference_versioned_docs/version-v4/cli/operations-api-commands.md - reference_versioned_docs/version-v4/cli/authentication.md - migration-context/link-placeholders/cli-link-placeholders.md Key Features: Version Annotations - All 72 CLI operations now include "Available Since" information with complete version coverage: - 51 operations from v4.3.0 - 11 operations from v4.4.0 (SSH and certificate operations) - 3 data operations from v4.4.9 (insert, update, upsert) - 3 status operations from v4.6.0 - Individual operations from v4.7.2 and v4.7.3 Authentication Documentation - Corrected to explain Unix domain socket authentication for local operations (automatically authenticated as superuser). Detailed environment variable and command parameter methods for remote operations with security best practices. Operations API Commands - Complete operations table with all 72 operations categorized by function, command aliases, parameter formatting guidelines, and cross-references to related sections via tip callouts. Process Management - Documented PID file location at <ROOTPATH>/hdb.pid, clarified foreground/background behavior for commands, and updated dev mode features. Link Management - 12 internal CLI section links resolved using relative paths. ~96 cross-section TODO links documented for future resolution in cli-link-placeholders.md. Content Consolidation - Merged content from v4.1 through v4.7 with inline version annotations following Node.js documentation patterns. Migration approach: - Single consolidated v4 reference (no separate v4.1-v4.7 versions) - Inline version annotations for feature availability - TODO: prefix for cross-section links pending future migrations - Comprehensive source attribution in HTML comments - Learn guide links use /learn paths - Consistent use of 'harper' command throughout 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com> * fixup! docs: migrate CLI section to v4 consolidated reference * fixup! docs: migrate CLI section to v4 consolidated reference --------- Co-authored-by: Claude Sonnet 4.5 <noreply@anthropic.com>
🚀 Preview DeploymentYour preview deployment is ready! 🔗 Preview URL: https://preview.harper-docs.stage.harperfabric.com/pr-436 This preview will update automatically when you push new commits. |
* docs: migrate GraphQL Querying section to v4 consolidated reference Generated with Claude Code (https://claude.com/claude-code) Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com> * fixup! docs: migrate GraphQL Querying section to v4 consolidated reference * fixup! fixup! docs: migrate GraphQL Querying section to v4 consolidated reference * Update reference_versioned_docs/version-v4/graphql-querying/overview.md Co-authored-by: Kris Zyp <kriszyp@gmail.com> * remove coming soon sections --------- Co-authored-by: Claude Sonnet 4.5 <noreply@anthropic.com> Co-authored-by: Kris Zyp <kriszyp@gmail.com>
🚀 Preview DeploymentYour preview deployment is ready! 🔗 Preview URL: https://preview.harper-docs.stage.harperfabric.com/pr-436 This preview will update automatically when you push new commits. |
* docs: migrate Studio section to v4 consolidated reference Generated with Claude Code (https://claude.com/claude-code) Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com> * fixup! docs: migrate Studio section to v4 consolidated reference * fixup! docs: migrate Studio section to v4 consolidated reference * fixup! docs: migrate Studio section to v4 consolidated reference * fixup! docs: migrate Studio section to v4 consolidated reference * fixup! fixup! docs: migrate Studio section to v4 consolidated reference * docs: update plans to clarify Studio vs Harper Cloud Studio distinction * manual edits * edit credentials/authentication info * move additional cloud docs over per discussion * simplify legacy cloud * remove reference to cloud in studio docs. * update link placeholders doc --------- Co-authored-by: Claude Sonnet 4.5 <noreply@anthropic.com>
🚀 Preview DeploymentYour preview deployment is ready! 🔗 Preview URL: https://preview.harper-docs.stage.harperfabric.com/pr-436 This preview will update automatically when you push new commits. |
* docs: migrate Fastify Routes section to v4 consolidated reference Generated with Claude Code (https://claude.com/claude-code) Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com> * fixup! docs: migrate Fastify Routes section to v4 consolidated reference * manual tweaks --------- Co-authored-by: Claude Sonnet 4.5 <noreply@anthropic.com>
🚀 Preview DeploymentYour preview deployment is ready! 🔗 Preview URL: https://preview.harper-docs.stage.harperfabric.com/pr-436 This preview will update automatically when you push new commits. |
🚀 Preview DeploymentYour preview deployment is ready! 🔗 Preview URL: https://preview.harper-docs.stage.harperfabric.com/pr-436 This preview will update automatically when you push new commits. |
🚀 Preview DeploymentYour preview deployment is ready! 🔗 Preview URL: https://preview.harper-docs.stage.harperfabric.com/pr-436 This preview will update automatically when you push new commits. |
* docs: migrate Environment Variables section to v4 consolidated reference Adds the Environment Variables section focused on the built-in `loadEnv` plugin. Harper-level env var configuration (naming conventions, HDB_CONFIG, HARPER_DEFAULT_CONFIG, HARPER_SET_CONFIG) is intentionally deferred to the Configuration section, with research notes captured in the migration map. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> * Update overview.md Co-authored-by: Chris Barber <chris@harperdb.io> * adjust intro * fix titles --------- Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com> Co-authored-by: Chris Barber <chris@harperdb.io>
🚀 Preview DeploymentYour preview deployment is ready! 🔗 Preview URL: https://preview.harper-docs.stage.harperfabric.com/pr-436 This preview will update automatically when you push new commits. |
* docs: migrate HTTP section to v4 consolidated reference Adds reference_versioned_docs/version-v4/http/ with four pages: - overview.md: architecture, threading model, protocols served - configuration.md: full http section config reference - tls.md: top-level tls section reference (shared by HTTP and MQTT) - api.md: server global API (server.http, Request/Response, server.ws, etc.) Also adds migration-context/link-placeholders/http-link-placeholders.md and updates the v4 sidebar and migration map status. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> * fixup! docs: migrate HTTP section to v4 consolidated reference --------- Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com>
🚀 Preview DeploymentYour preview deployment is ready! 🔗 Preview URL: https://preview.harper-docs.stage.harperfabric.com/pr-436 This preview will update automatically when you push new commits. |
* docs: migrate Static Files section to v4 consolidated reference - Add reference_versioned_docs/version-v4/static-files/overview.md covering the static built-in plugin: basic usage, files/urlPath, v4.7 options (index, extensions, fallthrough, notFound), auto-update behavior, and examples including SPA client-side routing pattern - Add Static Files category to version-v4 sidebar - Add migration-context/link-placeholders/static-files-link-placeholders.md - Update v4-docs-migration-map.md status to In Progress with source notes Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> * fixup! docs: migrate Static Files section to v4 consolidated reference --------- Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com>
🚀 Preview DeploymentYour preview deployment is ready! 🔗 Preview URL: https://preview.harper-docs.stage.harperfabric.com/pr-436 This preview will update automatically when you push new commits. |
🚀 Preview DeploymentYour preview deployment is ready! 🔗 Preview URL: https://preview.harper-documentation.harperfabric.com:9925//pr-436 This preview will update automatically when you push new commits. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This is the base branch for the major Docs to Reference migration and major version consolidation work.
Review the v4-* documents in the root for information on the project plan. Going to leverage agents to heavily automate this work but it will still involve lots of human-in-the-loop too.
Tracking migration of v4 documentation to consolidated structure.
Phase 1A - Simple Sections
Phase 1B - Medium Complexity
Phase 1C - Complex Sections
Phase 1D - Cross-Cutting
Phase 1E - Legacy
Part 2 - Link Resolution
Part 3 - Cross-References
Part 4 - Finalization
High level ideas from reviews: