Added obsidian use cases#1179
Conversation
|
@KarolaKirsanow is attempting to deploy a commit to the Discourse Graphs Team on Vercel. A member of the Team first needs to authorize it. |
|
Deployment failed with the following error: View Documentation: https://vercel.com/docs/accounts/team-members-and-roles |
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
|
Hi @KarolaKirsanow , I cleaned up this PR so it matches the current docs structure after #1210 and #1209 . What changed:
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:
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 fetch origin
git switch workflows01
git reset --hard origin/workflows01If your fork remote is not named After that, your local The preview has been updated: https://discourse-graph-git-fork-karolakirsanow-05be61-discourse-graphs.vercel.app/ Let me know if you see anything that was missed or encounter any issues! |
mdroidian
left a comment
There was a problem hiding this comment.
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)
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:
/docs/guides/obsidian/image.pngto avoid multiple naming collisions with the rest of the doc imagesImage borders
1px solid #cbcbcb) applied to use-case docs only, not all docsisUseCasePageprop (mdxPath[0] === "use-cases") passed from[[...mdxPath]]/page.tsx→DocsPageTemplate, which wraps content in<div className="use-case-content">nextra-css.css:.use-case-content img { border: 1px solid #cbcbcb; }Image sizing
| widthin alt text:— sets width in px, stripped from rendered altmdx-components.tsxviaDocImagewrapping the theme'sBaseImg(not a plain<img>) to preserve Nextra's path resolutionNode tag component
<nodetag type="hyp" />MDX shortcode to render colored pill tags in docs matching app node type colorscolorUtils.tspalette;colorprop available for per-instance overridesnodetag) — MDX in.mdfiles only routes lowercase JSX elements through_componentsCallouts
blockquoteMDX component override inmdx-components.tsxthat renders Obsidian-style callouts> [!type] Title(static),> [!type]+ Title(foldable open),> [!type]- Title(foldable closed)<details>/<summary>— no JS requiredinfo,tip,note,warning,caution,check,done,question,fail,error,danger,abstract,summary