docs: Add wiki. #1714
docs: Add wiki. #1714
Conversation
|
Was the wiki originally in the repo's root? Why was it removed? I can't remember now. Edit: Oh, I see it still in the .gitignore. So we just weren't tracking it. |
|
Whoops, pushed some irrelevant commits. Fixed now. |
|
|
||
| 2. In your terminal, navigate to your local **dcrdex** directory and clone the wiki from the **decred/dcrdex** repo. | ||
|
|
||
| `git clone https://github.com/decred/dcrdex.wiki.git wiki` |
There was a problem hiding this comment.
I guess most of the Home page describing how to contribute to the wiki is incorrect with this change, and can remove wiki-creation.png I suppose.
Now it's just something like: follow the instructions in docs/wiki/Contribution-Guide.md to clone the dcrdex repository and start a branch for your edits, edit the documents in docs/wiki, create a PR with those changes, and once it is merged and administrator will push the changes to the live GitHub Wiki.
There was a problem hiding this comment.
I've updated the instructions in #1715 what do you think about those?
There was a problem hiding this comment.
Oh ok so images/wiki-creation.png would still be used. That makes sense for previewing in your own fork's Wiki. I have a feeling I'd just do my best to use local previews on my computer's editor for markdown, just not mediawiki. But maybe I'd get comfy with force pushing the docs/wiki subtree to my wiki remote all the time.
There was a problem hiding this comment.
I suppose I'd have a remote called thewiki for https://github.com/decred/dcrdex.wiki.git, and another called mywiki for https://github.com/chappjc/dcrdex.wiki.git to make sure I don't get them mixed up if I'm making a wiki PR for instance.
There was a problem hiding this comment.
For someone with write access I guess so... I haven't actually tried yet with https://github.com/decred/dcrdex.wiki.git I wonder if I can write there because I'm a contributor? I'm not asking for write permissions, just wondering.
I have a feeling I'd just do my best to use local previews on my computer's editor for markdown
Your IDE?
There was a problem hiding this comment.
Anyway, do you want me to change the instructions in this pr? I was just planning on doing the move here but can move the instructions commit here.
There was a problem hiding this comment.
Yeah, IDE or other markdown enabled editor like ReText. There's a million of them.
Missed your last question, but I think this PR establishes the baseline docs/wiki folder that exactly matches the wiki at dcrdex.wiki.git, so it's perfect as-is.
git-subtree-dir: docs/wiki git-subtree-split: 3f0a68ea2897c54c64c9d859b7b7c5575fd4387e
|
just rebased |
|
@buck54321 any opinion on this pr? edit: merged, nvm I guess :P |
|
It's a pretty much direct import of the wiki. We can |
This adds the wiki as is to the docs folder. Suggested by @xaur in #1641
Created with the command:
Using my repo, but should be fine at the same comment 3f0a68ea2897c54c64c9d859b7b7c5575fd4387e
After these changes, collaborators can update the wiki here with pr's, as apposed to just bugging chapp. chapp/buck can update the wiki at any time with commands similar to:
I think.