MerginMaps / MerginMaps/docs

Create a visual guide on how files/folder structure works on the PC

Open
#476 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Vue
Stars
15
Forks
22
Avg merge
5d 11h
Merged PRs (30d)
9

Description

A visual guide to show how files are located on the app, how download/upload works, etc would be great.

Users are getting confused, with the fact that the files are not directly link to the cloud and they need to download a copy on their PC/app to work with. So, a visual guide to show that for each project, users usually have at least three copies of the same files: PC, mobile and server. When they make changes to a copy, the sync calculates the change and uploads the change.

If user wants to add/remove files from project, they need to do it in the working directory and then upload the changes.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the documentation pages and assets that explain project files, downloads, uploads, and synchronization. Confirm how the PC, mobile, and server copies are described today, then create a visual guide covering those copies and the working-directory add/remove workflow. Done means users can understand where files live and how changes are synchronized.

Written by the indexing model from the issue text.

Assessment

Domain
content, documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.