foambubble/foam

[Docs] Add Guide For Users Coming From Obsidian

Closed

#1,336 opened on Feb 22, 2024

View on GitHubContributor guide
 (8 comments) (1 reaction) (0 assignees)TypeScript (623 forks)batch import
documentationgood first issuehelp wanted

Repository metrics

Stars
 (14,407 stars)
PR merge metrics
 (Avg merge 4h 22m) (1 merged PR in 30d)

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

Research direction
Review existing docs, look at issue #46 for migration tools, and list open feature parity requests from Obsidian. Write a guide structure.
Tech stack
typescript
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.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80