Docs, for Moxie Docs

Use Friday Recap and Cleanup

2 min readUpdated

Overview

Friday Recap gives you a simple weekly summary of what changed in your docs and what needs attention. When useful fixes are available, it proposes a Friday Cleanup pull request (PR) that bundles safe, docs‑only updates for easy review. It’s designed for teams who want to keep docs tidy without chasing every small change.

When to use it

  • You want a quick, readable summary of weekly doc activity.
  • You need a single, reviewable PR that packages up multiple small fixes or deletions.
  • You prefer to decide if and when a Cleanup PR is opened, rather than auto‑merging changes.
  • You want to control who can see weekly recaps on the dashboard.

How to use it

  1. Open the Moxie Docs dashboard.
  2. Find the Friday Recap card on the dashboard. It lists the week’s highlights and any proposed Cleanup PR.
  3. Review the summary. Expand items to see suggested fixes, areas affected, and any orphaned pages flagged for deletion.
  4. Decide what to do:
    • If the recap looks useful, click Open Friday Cleanup PR on the card to create a docs‑only GitHub PR.
    • If it’s not relevant this week, click Dismiss to remove the recap from your view.
  5. Confirm the repository in the confirmation dialog. Moxie respects your repository settings and will never auto‑merge.
  6. Switch to GitHub when prompted and review the PR. The PR bundles related doc fixes to maximize value per slot.
  7. Request reviews from teammates as usual, then merge in GitHub when ready.
  8. Back in Moxie, check the Opportunity or Suggestions area on the dashboard. The status will reconcile after the PR is opened and merged, so remaining suggestions stay accurate.

Options and settings

  • Friday Recap card
    • Open Friday Cleanup PR: Creates a reviewable, docs‑only PR that groups related fixes and cleans up orphans when applicable.
    • Dismiss: Hides the recap for the week. Dismissed recaps don’t trigger a Cleanup PR.
  • Visibility
    • Recap visibility follows your dashboard access. Team members with dashboard access can see the Friday Recap card.
  • Automation behavior
    • Docs‑only PRs: Cleanup PRs never include code changes and never auto‑merge.
    • Repository settings respected: The PR uses your repo’s default branch and PR templates if configured.
    • Bundling by area: Related fixes are packaged together to reduce review overhead.

Tips

  • Skim the recap first; if the value is low this week, dismiss it and revisit next Friday.
  • Use PR templates to guide reviewers on what changed and how to verify. Moxie will apply your template if set up.
  • After merging, refresh the dashboard to see updated suggestion statuses and fewer repeat alerts.
  • If recaps feel noisy, tune detectors or mute specific drift alerts in the dashboard to improve future recommendations.

Was this page helpful?

Let us know if you found what you were looking for.

Related articles

DocumentationSet up your public knowledgebaseThis guide walks you through turning a connected repository into a public help center on y
DocumentationGetting started with Moxie DocsIn a few minutes, you will connect a GitHub repository, let Moxie Docs scan for documentat
DocumentationGet started: connect GitHub and reach first doc valueOverview Connect your GitHub repository to Moxie, let Moxie index your codebase, and revie