Skip to content

Add housekeeping documentation#291

Merged
hackerwins merged 1 commit intomainfrom
housekeeping
Feb 9, 2026
Merged

Add housekeeping documentation#291
hackerwins merged 1 commit intomainfrom
housekeeping

Conversation

@hackerwins
Copy link
Member

@hackerwins hackerwins commented Feb 9, 2026

What this PR does / why we need it?

Refactor doc structure for consistency across the project

Any background context you want to provide?

What are the relevant tickets?

Fixes #

Checklist

  • Added relevant tests or not required
  • Didn't break anything

Summary by CodeRabbit

Documentation

  • Documentation
    • Reorganized navigation menu: replaced platform-specific SDK references with Tools & APIs, Self-Hosted Server, and new Configuration and Internals sections
    • Added comprehensive Housekeeping documentation describing background service operations including client deactivation and document compaction
    • Enhanced glossary entries with detailed descriptions and cross-references
    • Updated internal documentation links for consistency

@coderabbitai
Copy link

coderabbitai bot commented Feb 9, 2026

📝 Walkthrough

Walkthrough

The documentation navigation structure is reorganized by updating menu items in UI components (replacing SDK references with Tools & APIs, Self-Hosted Server, and new sections) while simultaneously expanding documentation content with a new detailed page about the Housekeeping background service.

Changes

Cohort / File(s) Summary
UI Navigation Components
components/Layout/Footer.tsx, components/Layout/MobileGnbDropdown.tsx
Updated documentation menu items by replacing iOS SDK and Android SDK references with Tools & APIs, Self-Hosted Server, Configuration, Internals, and Glossary entries, with corresponding route updates and active path checks.
Documentation Link References
docs/advanced/projects.mdx, docs/internals/synchronization.mdx
Updated hyperlinks for Housekeeping references to point to the new dedicated page at /docs/internals/housekeeping instead of /docs/glossary.
Documentation Structure Updates
docs/glossary.mdx, docs/internals.mdx
Expanded glossary entries for Attach/Detach and Housekeeping with lifecycle-focused descriptions and links; added Housekeeping topic entry to the Internals index.
New Documentation Content
docs/internals/housekeeping.mdx
Created comprehensive documentation page for the Housekeeping background service, covering client deactivation, document compaction, configuration options, cluster mode behavior, and monitoring aspects.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Poem

🐰 The docs now hop with clearer maps,
Where Tools and Internals fill the gaps,
Housekeeping finds its rightful place,
No more breadcrumbs lost in space! 🌱

🚥 Pre-merge checks | ✅ 2 | ❌ 1
❌ Failed checks (1 warning)
Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. Write docstrings for the functions missing them to satisfy the coverage threshold.
✅ Passed checks (2 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately describes the main change: refactoring documentation structure by reorganizing navigation menus and restructuring docs sections for consistency.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing touches
  • 📝 Generate docstrings
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch housekeeping

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 and usage tips.

@hackerwins hackerwins changed the title Refactor doc structure for consistency across the project Add housekeeping documentation Feb 9, 2026
Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (1)
docs/glossary.mdx (1)

53-53: ⚠️ Potential issue | 🟡 Minor

Housekeeping link in Document Compaction entry is a self-referential link to /docs/glossary instead of /docs/internals/housekeeping.

All other files in this PR update Housekeeping references to point to /docs/internals/housekeeping. This entry was likely missed during the refactor.

Proposed fix
-| [Document Compaction](/docs/internals/synchronization#document-compaction) | A server-side process that consolidates old change history into a single snapshot to reduce storage overhead. Performed by [Housekeeping](/docs/glossary) on documents that are not currently attached. |
+| [Document Compaction](/docs/internals/synchronization#document-compaction) | A server-side process that consolidates old change history into a single snapshot to reduce storage overhead. Performed by [Housekeeping](/docs/internals/housekeeping) on documents that are not currently attached. |

@hackerwins hackerwins merged commit 26c4925 into main Feb 9, 2026
2 checks passed
@hackerwins hackerwins deleted the housekeeping branch February 9, 2026 05:23
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.

1 participant