Skip to content

Docs for backups - #2858

Merged
dwwoelfel merged 9 commits into
mainfrom
backups-docs
Aug 12, 2026
Merged

Docs for backups#2858
dwwoelfel merged 9 commits into
mainfrom
backups-docs

Conversation

@dwwoelfel

@dwwoelfel dwwoelfel commented Aug 11, 2026

Copy link
Copy Markdown
Contributor

Adds docs for backups explaining how they're created, how they're structured, how to download them, and a short description of how to restore a backup into a self-hosted instance (with a link to the self-hosted docs).

Direct preview link: https://instant-www-js-backups-docs-jsv.vercel.app/docs/backups

@coderabbitai

coderabbitai Bot commented Aug 11, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

Note

Reviews paused

It looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the reviews.auto_review.auto_pause_after_reviewed_commits setting.

Use the following commands to manage reviews:

  • @coderabbitai resume to resume automatic reviews.
  • @coderabbitai review to trigger a single review.

Use the checkboxes below for quick actions:

  • ▶️ Resume reviews
  • 🔍 Trigger review

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro Plus

Run ID: 30658f00-d98a-4e7b-9259-3ea88686325c

📥 Commits

Reviewing files that changed from the base of the PR and between 51edb66 and 70fbe0f.

📒 Files selected for processing (1)
  • client/www/app/docs/backups/page.md
🚧 Files skipped from review as they are similar to previous changes (1)
  • client/www/app/docs/backups/page.md

📝 Walkthrough

Walkthrough

Added an Instant backups documentation page for access, archive contents, sensitive data, restoration, and CLI commands. Added the page to the Instant features documentation navigation.

Changes

Backup documentation

Layer / File(s) Summary
Backup access and archive structure
client/www/app/docs/backups/page.md, client/www/data/docsNavigation.js
Documents nightly backups, dashboard and CLI access, archive contents, entity formats, file storage, and sensitive-data handling. Adds the Backups navigation link.
Self-hosted restoration
client/www/app/docs/backups/page.md
Documents self-hosted restoration steps, deployment superuser configuration, and OAuth client-secret updates.
Backup CLI reference
client/www/app/docs/backups/page.md
Documents commands for listing backups, JSON output, interactive or targeted downloads, output paths, app selection, and help flags.

Estimated code review effort: 2 (Simple) | ~10 minutes

Possibly related PRs

Suggested reviewers: stopachka

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and concisely identifies the main change: adding backup documentation.
Description check ✅ Passed The description accurately summarizes the backup documentation, download guidance, and self-hosted restoration information.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 2

🧹 Nitpick comments (1)
client/www/components/docs/Fence.jsx (1)

131-131: 🎯 Functional Correctness | 🔵 Trivial | 💤 Low value

Use the Tailwind CSS v4 important-modifier syntax. Tailwind CSS v4.1.17 supports the prefix form for backward compatibility but deprecates it. Replace !mt-0 and !rounded-t-none with mt-0! and rounded-t-none!.

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@client/www/components/docs/Fence.jsx` at line 131, Update the className
template in Fence to use Tailwind CSS v4 important-modifier suffix syntax:
replace !mt-0 with mt-0! and !rounded-t-none with rounded-t-none!, preserving
the existing conditional styling and all other classes.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@client/www/app/docs/backups/page.md`:
- Line 63: Replace the real-looking email value in the backup example with the
synthetic address user@example.com, while leaving the rest of the example
unchanged.
- Around line 8-10: Update the backup retention documentation around the “last 7
days” statement to explicitly identify those as automatic backups, then add that
manual backups default to a 30-day retention period. Preserve the existing
dashboard and CLI access information.

---

Nitpick comments:
In `@client/www/components/docs/Fence.jsx`:
- Line 131: Update the className template in Fence to use Tailwind CSS v4
important-modifier suffix syntax: replace !mt-0 with mt-0! and !rounded-t-none
with rounded-t-none!, preserving the existing conditional styling and all other
classes.
🪄 Autofix

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro Plus

Run ID: 4836fc09-5152-4c03-aeed-8e7b229abf70

📥 Commits

Reviewing files that changed from the base of the PR and between df5c765 and 5477712.

📒 Files selected for processing (4)
  • client/www/app/docs/backups/page.md
  • client/www/components/docs/Fence.jsx
  • client/www/data/docsNavigation.js
  • client/www/markdoc/nodes.js

Comment thread client/www/app/docs/backups/page.md
Comment thread client/www/app/docs/backups/page.md
@github-actions

Copy link
Copy Markdown
Contributor

View Vercel preview at instant-www-js-backups-docs-jsv.vercel.app.

@dwwoelfel dwwoelfel changed the title [WIP] Backups docs Backups docs Aug 11, 2026
@dwwoelfel dwwoelfel changed the title Backups docs Docs for backups Aug 11, 2026
@dwwoelfel
dwwoelfel marked this pull request as ready for review August 11, 2026 23:29

@nezaj nezaj left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@dwwoelfel
dwwoelfel merged commit 6a5ab20 into main Aug 12, 2026
29 checks passed
@dwwoelfel
dwwoelfel deleted the backups-docs branch August 12, 2026 00:02
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