micro-editor / micro-editor/micro

Port the existing in-app wiki to GH wiki?

Open
#3,841 4 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Go
Stars
29.6k
Forks
1.4k
Avg merge
2d 18h
Merged PRs (30d)
10

Description

I wouldn't mind pushing the changes myself, but we do have existing documentation files for micro, which can be accessed within the app, but just in case some people want to have it on a website as they might be new micro users and confused about things such as default keybinds etc, and not very learned in the ways of hunting repos for the MD files, we could pop them up on the nice in-built wiki here! I haven't seen a PR or FR ticket listed for this yet so I thought I'd pop it up and take a shot at it possibly?

Contributor guide

No contributing guide indexed for this repository

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

Locate the existing documentation files for micro and review how they are accessed within the app, then inspect the repository's GitHub wiki. Define which material, including default keybindings and other newcomer guidance, should be published; done means the agreed documentation is available and readable in the wiki.

Written by the indexing model from the issue text.

Assessment

Tech stack
github
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.