Opportunity cards seem noisy or wrong
Overview
This guide helps when documentation pages don’t show up in Docs home, content looks stale after a recent commit, or search results lag behind your latest changes. It also shows how to reduce noise in drift findings so you only see opportunities that matter.
Before you start
- You can sign in to your Moxie Docs workspace.
- Your GitHub repository is already connected to Moxie Docs.
- You can open the Dashboard and see “Docs home.”
Pages don’t appear in Docs home or collections
You land on “Docs home” but expected to see your repository’s pages organized into collections, and some are missing. This can happen right after connecting a repo or when a collection has no indexed content yet.
- Open the Dashboard and go to “Docs home.”
- Check the collection grid for your expected collections. If a collection is hidden, unhide it so it’s visible in the grid.
- You can browse, favorite, hide, and open collections once indexing has content.
- Open a visible collection you expect to contain the page and browse its items.
- Search using the search bar on “Docs home” for the page title or keywords to confirm whether it’s indexed.
- Wait a few minutes if you just connected the repo or made large changes; pages appear after indexing has content.
- Verify that the page actually exists in your GitHub repo; Moxie Docs indexes from your code and docs.
Content looks stale after a recent commit
You edited docs in GitHub, but the page in Moxie Docs still shows the older version. This is usually due to indexing not having finished yet.
- Confirm your change was merged to the default branch in GitHub.
- Open “Docs home,” then use the search bar to find the page and open it from results.
- Refresh the page in your browser and wait a short time for indexing to complete if the content still appears older.
- Review “Documentation opportunities” on “Docs home” to see if a suggested PR is listed for an update. If present, preview changes and create PR to update outdated docs in your GitHub repo.
Search results don’t reflect recent changes
You run a search on “Docs home” or inside a collection and results don’t match your latest edits. Hybrid vector search returns relevant pages quickly, but it relies on indexed content.
- Use the exact terms from your recent commit or the page title to narrow results.
- Clear the query and retype a non-empty search; empty queries return no results.
- Wait a few minutes after large edits; results update once indexing completes.
- Provide feedback on a result using thumbs up/down with tags and an optional comment to improve results over time.
Drift findings feel noisy or low value
Your “Documentation opportunities” list shows many drift findings, and it’s hard to focus on what matters. You can mute, dismiss, or skip items to keep your queue actionable.
- Open “Docs home” and search or browse to the “Documentation opportunities” section.
- Review each finding’s type and severity to decide whether it needs action now.
- Dismiss findings that are not issues so they leave your active list.
- Mute findings you don’t want to review for a period so they stop surfacing while you focus elsewhere.
- Skip low-priority items for now and focus on higher-severity findings.
- Preview suggested changes, then create PR for items that need updates in your GitHub repo.
- Use favorites on collections you work on most so high-signal areas are easy to reach.
- Hiding low-relevance collections reduces visual noise on “Docs home.”
Suggested or open PRs don’t match what you expect
You see suggested or open PRs in “Documentation opportunities,” but they don’t reflect your preferred change or target file.
- Open the suggested or open PR from the list to preview the diff.
- Verify the changes match your intent. If not, dismiss the finding to remove it from the queue.
- Edit your docs directly in GitHub if a different update is needed; once merged, wait for indexing and recheck the list.
Still need help
- Recheck that you’re on “Docs home,” using a non-empty search query, and that your GitHub changes are merged to the branch Moxie Docs indexes.
- If pages or findings remain incorrect after waiting for indexing, contact your workspace admin to confirm the repository connection and access.
- If the issue persists, reach out to Moxie Docs support with the page URL, your search query, and a brief description of the mismatch.
Was this page helpful?
Let us know if you found what you were looking for.