Markdown-Edit icon indicating copy to clipboard operation
Markdown-Edit copied to clipboard

Wiki Documentation

Open mike-ward opened this issue 9 years ago • 9 comments

I've started a Wiki to document Markdown Edit. Please contribute if you can.

~~GitHub wiki's are clonable. Clone it, edit and submit a pull request~~.

mike-ward avatar Feb 27 '16 13:02 mike-ward

Think Im being a numpty but.... how do I enter editing mode??

Saturday, February 27, 2016, 1:50:50 PM, you wrote:

MW> I've started a Wikito document Markdown Edit. Please contribute if you can. MW> — MW> Reply to this email directly or view it on GitHub. MW>
MW>


Mike Smith

mikjsmith avatar Feb 27 '16 15:02 mikjsmith

~~Hi,~~

~~You can't edit it directly. You have to clone it locally to your computer, make your changes and then submit a pull request.~~

~~It's not hard but it is odd and different if you've never done this kind of thing before.~~

It can be edited directly now

mike-ward avatar Feb 27 '16 17:02 mike-ward

Wikis have pull requests? How do I open one?

borekb avatar Mar 06 '16 09:03 borekb

~~You clone like any other repository. The link is in the wiki sidebar.~~

mike-ward avatar Mar 06 '16 13:03 mike-ward

Yeah I know about cloning but how do I create a branch for the change and open a PR for it?

borekb avatar Mar 06 '16 13:03 borekb

Yikes! Looks like you can't send PR's to wiki in GitHub. That's a surprise. I'll open up the wiki so others can edit.

mike-ward avatar Mar 06 '16 13:03 mike-ward

OK, it's open to everyone now.

mike-ward avatar Mar 06 '16 13:03 mike-ward

Yep, that's the simplest.

I've also seen a setup where the main wiki repo has a "sister" repo (full-fledged) where PRs are accepted and then synced back to the wiki. TypeScript team uses that:

  • the wiki https://github.com/Microsoft/TypeScript.wiki.git
  • its sister repo https://github.com/Microsoft/TypeScript-wiki.git – accepting PRs

borekb avatar Mar 06 '16 13:03 borekb

I think it's weird that GitHub allows you clone it but not generate pull requests. After all, it's a repository

mike-ward avatar Mar 06 '16 14:03 mike-ward