Skip to content

docs(examples): add MOC link dashboard workflow#1138

Merged
chhoumann merged 1 commit intomasterfrom
docs/moc-link-dashboard-example
Mar 7, 2026
Merged

docs(examples): add MOC link dashboard workflow#1138
chhoumann merged 1 commit intomasterfrom
docs/moc-link-dashboard-example

Conversation

@chhoumann
Copy link
Copy Markdown
Owner

@chhoumann chhoumann commented Mar 7, 2026

Add a new docs example for creating MOC notes with an embedded link dashboard.

This documents the map-of-knowledge workflow we validated in the dev vault: a Template choice that creates a markdown note with an embedded .base dashboard showing backlinks and outgoing links. It also links the example from the Template and Capture docs, the docs landing page, and the examples sidebar so users can actually find it.

I considered keeping this as a dev-vault-only demo, but documenting it makes the workflow reusable for users without requiring them to inspect vault fixtures or screenshots in chat.

Reviewer context:

  • Docs and image only; no plugin runtime changes.
  • Screenshot was re-taken from the dev vault with the file explorer/sidebar hidden.
  • Verification: bun run build-with-lint
  • Verification: cd docs && bun run build

Open with Devin

Summary by CodeRabbit

  • Documentation
    • Added comprehensive guide for creating MOC notes with embedded live Base dashboards using templates
    • Updated references in documentation to direct users to the new template example
    • Enhanced documentation navigation with new template example entry

@vercel
Copy link
Copy Markdown

vercel Bot commented Mar 7, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
quickadd Ready Ready Preview Mar 7, 2026 2:50pm

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Mar 7, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: e96a8c17-84b0-409a-8bfb-fe42339b6529

📥 Commits

Reviewing files that changed from the base of the PR and between 720ee31 and 06a38b6.

⛔ Files ignored due to path filters (1)
  • docs/docs/Images/template_moc_link_dashboard_demo.png is excluded by !**/*.png
📒 Files selected for processing (5)
  • docs/docs/Choices/CaptureChoice.md
  • docs/docs/Choices/TemplateChoice.md
  • docs/docs/Examples/Template_CreateMOCNoteWithLinkDashboard.md
  • docs/docs/index.md
  • docs/sidebars.js

📝 Walkthrough

Walkthrough

Documentation enhancement adding a comprehensive guide for creating an MOC note with an embedded live Base dashboard using QuickAdd templates. Includes a new example template file and cross-references added to related choice documentation and navigation.

Changes

Cohort / File(s) Summary
New Template Example Documentation
docs/docs/Examples/Template_CreateMOCNoteWithLinkDashboard.md
New comprehensive guide documenting how to create a reusable QuickAdd template for MOC notes with embedded live Base dashboards, including setup steps, template YAML structure, configuration, and expected behavior.
Documentation Cross-references
docs/docs/Choices/CaptureChoice.md, docs/docs/Choices/TemplateChoice.md, docs/docs/index.md
Added links pointing to the new template example within existing documentation sections for discoverability.
Navigation Configuration
docs/sidebars.js
Added new documentation entry to the "Template Examples" sidebar category for navigation access.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Poem

🐰 A template so grand, with dashboards that dance,
Links weaving together in QuickAdd's romance,
New MOCs take the stage, with bases alive,
Our docs now guide builders to help them all thrive! ✨📋

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately summarizes the main change: adding documentation for an MOC (map-of-knowledge) link dashboard workflow example, which is reflected across all modified files.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

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

✨ Finishing Touches
  • 📝 Generate docstrings (stacked PR)
  • 📝 Generate docstrings (commit on current branch)
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch docs/moc-link-dashboard-example

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.

@cloudflare-workers-and-pages
Copy link
Copy Markdown

Deploying quickadd with  Cloudflare Pages  Cloudflare Pages

Latest commit: 06a38b6
Status: ✅  Deploy successful!
Preview URL: https://71a756dd.quickadd.pages.dev
Branch Preview URL: https://docs-moc-link-dashboard-exam.quickadd.pages.dev

View logs

@chhoumann chhoumann marked this pull request as ready for review March 7, 2026 14:59
Copy link
Copy Markdown
Contributor

@devin-ai-integration devin-ai-integration Bot left a comment

Choose a reason for hiding this comment

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

✅ Devin Review: No Issues Found

Devin Review analyzed this PR and found no bugs or issues to report.

Open in Devin Review

@chhoumann chhoumann merged commit d73cb26 into master Mar 7, 2026
5 checks passed
@chhoumann chhoumann deleted the docs/moc-link-dashboard-example branch March 7, 2026 15:08
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