Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Wiki as git sub-module #1271

Open
tonytheodore opened this issue Mar 22, 2016 · 3 comments
Open

Wiki as git sub-module #1271

tonytheodore opened this issue Mar 22, 2016 · 3 comments

Comments

@tonytheodore
Copy link
Member

There's some very useful documentation hidden in https://github.com/mxe/mxe/wiki and I'd like to make this available in the main tree (with the longer term aim of moving all docs to wiki/markdown style and reserve index.html for "website" info - intro, contacts, external links etc).

Does anyone have experience with keeping these in sync?

@starius
Copy link
Member

starius commented Mar 22, 2016

git submodule add https://github.com/mxe/mxe.wiki.git doc/wiki

I think, it is better to keep all the information in the repo itself. For example, if you change something, you can (and should) change the documentation of this feature in the same commit.

@tonytheodore
Copy link
Member Author

Indeed, actual content is more important than clever ways to format and sync it.

@starius
Copy link
Member

starius commented Dec 15, 2016

I want to revisit this issue. Page Add a New Package: Full Version seems to have an outdated template in the bottom that caused confusion.

Can we update all wiki pages, then move them to mxe/docs and then remove the wiki?

@starius starius reopened this Dec 15, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants