Skip to content

Document harper-config.yaml backup behavior#487

Merged
heskew merged 1 commit intomainfrom
docs/config-file-backups
May 6, 2026
Merged

Document harper-config.yaml backup behavior#487
heskew merged 1 commit intomainfrom
docs/config-file-backups

Conversation

@heskew
Copy link
Copy Markdown
Member

@heskew heskew commented May 6, 2026

Summary

  • Adds a Configuration File Backups section to reference/configuration/overview.md describing when Harper writes timestamped copies of harper-config.yaml to {rootPath}/backup/.
  • Currently the only mention of this behavior anywhere is a single line in harper/static/README.md (the default install landing page), which means it doesn't surface in doc-site search.
  • Section covers: trigger paths (operations API set_configuration and CLI/env-var startup args), file location and naming convention (<ISO-timestamp>-harper-config.yaml.bak), the carve-out that direct YAML edits and HARPER_SET_CONFIG / HARPER_DEFAULT_CONFIG do not produce timestamped backups, no rotation, and silent-on-failure behavior.

Cross-links to the existing State Tracking section so readers see how the same backup/ folder is also used by the env-var configuration mechanism.

Test plan

  • Render reference/configuration/overview.md locally and confirm the new section appears between Setting Configuration Values and Custom Config File Path.
  • Verify the in-page anchor link to #state-tracking resolves.
  • Search the rendered docs for "backup" and confirm the new section appears in results.

🤖 Generated with Claude Code

Adds a "Configuration File Backups" section to the configuration
overview describing when Harper writes timestamped copies of
harper-config.yaml to {rootPath}/backup/, so the behavior is
discoverable via doc search.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@heskew heskew requested a review from a team as a code owner May 6, 2026 22:03
@github-actions github-actions Bot temporarily deployed to pr-487 May 6, 2026 22:05 Inactive
@github-actions
Copy link
Copy Markdown

github-actions Bot commented May 6, 2026

🚀 Preview Deployment

Your preview deployment is ready!

🔗 Preview URL: https://preview.harper-documentation.harperfabric.com/pr-487

This preview will update automatically when you push new commits.

@heskew heskew merged commit a3907f6 into main May 6, 2026
7 checks passed
@heskew heskew deleted the docs/config-file-backups branch May 6, 2026 22:24
@github-actions
Copy link
Copy Markdown

github-actions Bot commented May 6, 2026

🧹 Preview Cleanup

The preview deployment for this PR has been removed.

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.

2 participants