Skip to content

Added obsidian use cases#1179

Draft
KarolaKirsanow wants to merge 14 commits into
DiscourseGraphs:mainfrom
KarolaKirsanow:workflows01
Draft

Added obsidian use cases#1179
KarolaKirsanow wants to merge 14 commits into
DiscourseGraphs:mainfrom
KarolaKirsanow:workflows01

Conversation

@KarolaKirsanow

@KarolaKirsanow KarolaKirsanow commented Jun 30, 2026

Copy link
Copy Markdown

This PR updates the navigation in the roam & obsidian docs pages & adds 5 use cases: project tracking, experiment tracking, literature synthesis, building a pkm base, and sharing your research

Additional changes:

  • placed docs in content/obsidian/use-cases/
  • Images placed in /docs/guides/obsidian/image.png to avoid multiple naming collisions with the rest of the doc images

Image borders

  • Border (1px solid #cbcbcb) applied to use-case docs only, not all docs
  • Implemented via isUseCasePage prop (mdxPath[0] === "use-cases") passed from [[...mdxPath]]/page.tsxDocsPageTemplate, which wraps content in <div className="use-case-content">
  • CSS rule in nextra-css.css: .use-case-content img { border: 1px solid #cbcbcb; }

Image sizing

  • Use | width in alt text: ![description | 400](image.png) — sets width in px, stripped from rendered alt
  • Implemented in mdx-components.tsx via DocImage wrapping the theme's BaseImg (not a plain <img>) to preserve Nextra's path resolution

Node tag component

  • Added <nodetag type="hyp" /> MDX shortcode to render colored pill tags in docs matching app node type colors
  • Colors sourced from app's colorUtils.ts palette; color prop available for per-instance overrides
  • Must use lowercase name (nodetag) — MDX in .md files only routes lowercase JSX elements through _components

Callouts

  • Added blockquote MDX component override in mdx-components.tsx that renders Obsidian-style callouts
  • Syntax: > [!type] Title (static), > [!type]+ Title (foldable open), > [!type]- Title (foldable closed)
  • Foldable callouts use native <details>/<summary> — no JS required
  • Implemented as a render-time component (not a rehype plugin) to avoid Turbopack's serialization constraint on function-valued loader options
  • Supported types: info, tip, note, warning, caution, check, done, question, fail, error, danger, abstract, summary

@vercel

vercel Bot commented Jun 30, 2026

Copy link
Copy Markdown

@KarolaKirsanow is attempting to deploy a commit to the Discourse Graphs Team on Vercel.

A member of the Team first needs to authorize it.

@KarolaKirsanow KarolaKirsanow added the documentation Improvements or additions to documentation label Jun 30, 2026
@joelchan joelchan requested a review from mdroidian July 8, 2026 03:39
@vercel

vercel Bot commented Jul 8, 2026

Copy link
Copy Markdown

Deployment failed with the following error:

You don't have permission to create a Preview Deployment for this Vercel project: discourse-graph.

View Documentation: https://vercel.com/docs/accounts/team-members-and-roles

@vercel

vercel Bot commented Jul 8, 2026

Copy link
Copy Markdown

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

Project Deployment Actions Updated (UTC)
discourse-graph Ready Ready Preview, Comment Jul 9, 2026 6:12am

Request Review

@mdroidian

mdroidian commented Jul 9, 2026

Copy link
Copy Markdown
Member

Hi @KarolaKirsanow , I cleaned up this PR so it matches the current docs structure after #1210 and #1209 .

What changed:

  • Rebased/cleaned the branch against the current docs tree.
  • Kept your intended content changes, including the new Obsidian use case pages and the Roam use case updates/removals.
  • Removed remaining stale/dead-tree docs references from the old docs structure.
  • Moved the Obsidian image assets into the existing public/docs/obsidian pattern.
  • Replaced the custom image-border handling with docs styling that works through the current Nextra/Next docs setup.
  • Changed custom callout handling to use Nextra Callout components.
  • Changed node tags to use a shared NodeTag component with the canonical node colors.
  • Added contributor/LLM docs guidance so future docs updates use existing NodeTag when applicable

A few things we should discuss:

Images

I am not fully comfortable with the image styling setup yet. The current cleanup avoids custom per-page image-border code, but ideally image styling should be unified across the docs. We should decide whether the goal is:

  • one consistent image style across docs, or
  • some controlled way to opt into image variants per image and what that includes

If per-image styling is important, we should define what that looks like before adding more affordances.

Callouts

The custom callouts were replaced with Nextra callouts. Nextra callouts do not currently have collapse/expand behavior. If collapsible callouts would be genuinely useful, I think we can add that with low effort, but it should probably be a separate small improvement rather than mixed into content updates.

Tying Linear tickets to PR's

A practice the dev team has is to start the PR title with the linear ticket ID (eg: FEE-1234 Added obsidian use cases)

That way the ticket automagically get attached to the PR and closes when the PR merges. This also helps the team keep track with the direction, status, etc. You can see more here: Project Handbook > Dev Ops


How to get your local branch up to date:

Because this branch was cleaned up with a force-push, a normal git pull may not work cleanly. First save any local uncommitted work, then run:

git fetch origin
git switch workflows01
git reset --hard origin/workflows01

If your fork remote is not named origin, replace origin with the remote name for your fork.

After that, your local workflows01 branch should match the PR again.


The preview has been updated: https://discourse-graph-git-fork-karolakirsanow-05be61-discourse-graphs.vercel.app/
Because this is from a fork, each update to the website preview must be approved, I believe.

Let me know if you see anything that was missed or encounter any issues!

@mdroidian mdroidian left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

We can merge as is but we should discuss the image direction shortly after.

Callout decision can wait, but would also be good to discuss.

See more above: #1179 (comment)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants