foambubble/foam

[Docs] Add Guide For Users Coming From Obsidian

Open

#1336 opened on Feb 22, 2024

View on GitHub
 (8 comments) (1 reaction) (0 assignees)TypeScript (14,407 stars) (623 forks)batch import
documentationgood first issuehelp wanted

Description

Is your feature request related to a problem? Please describe.

I've noticed in the Discord a number of users coming from Obsidian, and a quick search through Issues here show a number of feature requests for parity with it.

Describe the solution you'd like

I think it would be useful to have a page or section that talks about the differences from Obsidian, how to migrate (perhaps with link to tools like what might have been created some time ago in #46 ), and the open feature parity requests.

Describe alternatives you've considered

There's not really alternatives to be had to this, other than to keep revisiting these requests on the Discord server.

Screenshots or Videos

No response

Contributor guide

Tech stack
None
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Familiarity with ObsidianBasic knowledge of FoamUnderstanding of markdown
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75
Research direction
First, explore the existing documentation structure in the Foam repository, particularly the 'docs' folder. Review issue #46 for any migration tools or previous work. Gather common feature parity requests from Discord discussions and other issues. Then, create a new documentation page that compares Foam and Obsidian, outlines migration steps, and links to relevant feature requests. Ensure the page is easy to find and update the repository index if needed.