Docs Home and collections
Overview
Docs Home shows your repository’s generated documentation organized into labeled collections, such as Get started, Architecture, or Backend. It’s for anyone who needs to quickly browse what Moxie Docs has indexed and open pages once content is available. From here you can mark favorite collections, hide ones you don’t use, and jump into pages as soon as indexing finishes.
When to use it
- You want a quick, organized view of your docs by topic.
- You need to find and open generated pages after indexing completes.
- You want to favorite high‑value collections to keep them handy.
- You prefer to hide collections that aren’t relevant to your work.
How to use it
- Open the Dashboard and go to Docs Home. You’ll see a grid of labeled collections for your repository.
- Browse the collection grid to scan topics. Each tile represents a collection generated from your code and docs.
- Check indexing status. Collections and pages are available to open once indexing has content. If a collection is still empty, come back after indexing completes.
- Open a collection to view its pages. Select a collection tile to see the generated pages inside it.
- Open a page. Choose a page from the list to read the generated documentation.
- Favorite a collection you use often. Select the Favorite control on the collection to keep it easy to find.
- Hide a collection you don’t need. Select the Hide control to remove it from your default view. You can return later and show it again from the same control.
Options and settings
- Favorite: Pin a collection you use frequently so it’s easier to spot in the grid.
- Hide: Remove a collection from your default view without deleting any documentation.
- Indexing status: Collections and their pages become available to open once indexing has content.
Tips
- If a collection looks empty, indexing may still be running or no matching content was found yet. Check back after indexing completes.
- Favoriting and hiding affect only your view and do not change the underlying documentation.
- Use clear collection labels (like Get started or Backend) to quickly narrow down where your page is likely to be.
Was this page helpful?
Let us know if you found what you were looking for.