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 documentation out of sync ? #968

Closed
PierreR opened this issue Oct 28, 2015 · 11 comments
Closed

Wiki documentation out of sync ? #968

PierreR opened this issue Oct 28, 2015 · 11 comments

Comments

@PierreR
Copy link
Contributor

PierreR commented Oct 28, 2015

I was willing to contribute to some documentation but the online wiki looks out of sync with its source.

To illustrate, haskell-indentation-show-indentations for instance still appears in the wiki doc but does not seem to be anywhere in the source file

@gracjan
Copy link
Contributor

gracjan commented Oct 28, 2015

Manual is here:

http://haskell.github.io/haskell-mode/manual/latest/

Material from the wiki should be moved to official manual in
haskell-mode.texi.

2015-10-28 9:58 GMT+01:00 Pi3r [email protected]:

I was willing to contribute to some documentation but the online wiki
https://github.com/haskell/haskell-mode/wiki/Indentation looks out of
sync with its source
https://github.com/PierreR/haskell-mode/blob/master/doc/haskell-mode.texi
.


Reply to this email directly or view it on GitHub
#968.

@PierreR
Copy link
Contributor Author

PierreR commented Oct 28, 2015

Ah right. Can I at least update the link from the README page to point to the real manual if this can help.

@gracjan
Copy link
Contributor

gracjan commented Oct 28, 2015 via email

@PierreR
Copy link
Contributor Author

PierreR commented Oct 28, 2015

Ok. I guess the source for the wiki is on the gh-pages branch ? Could you point me to the sections that hasn't been integrated yet ?

@gracjan
Copy link
Contributor

gracjan commented Oct 28, 2015

Soirce is in doc/haskell-mode.texi. Web page updates itself when merged.

@PierreR
Copy link
Contributor Author

PierreR commented Oct 28, 2015

Then I don't get it. I thought doc/haskell-mode.texi was the source for http://haskell.github.io/haskell-mode/manual/latest/ not the wiki.

@gracjan
Copy link
Contributor

gracjan commented Oct 28, 2015

Please edit doc/haskell-mode.texi. This is the official documentation. Wiki needs to gradually be displaced.

@PierreR
Copy link
Contributor Author

PierreR commented Oct 28, 2015

Yes I know but you suggest I displaced content from the wiki into doc/haskell-mode.texi. I can copy paste from the web interface but it might be more convenient to copy from the actual source. So my question was what is the source file for the wiki. The stuff I want to copy from when/if it is still relevant. Sure I will copy to doc/haskell-mode.texi.

@gracjan
Copy link
Contributor

gracjan commented Oct 28, 2015

Oh, I see. Wiki is edited inplace on github. The wiki is the source for itself, although it can be accessed via git (github has info how to do this somewhere).

@PierreR
Copy link
Contributor Author

PierreR commented Oct 28, 2015

Ok thanks ;-)

@gracjan
Copy link
Contributor

gracjan commented Oct 28, 2015

So I close this one.

@gracjan gracjan closed this as completed Oct 28, 2015
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