-
-
Notifications
You must be signed in to change notification settings - Fork 238
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
Fix invalid link to documentation #468
Conversation
Merged, thanks! |
Actually I most likely will broke it again very soon, and won't be able to fix it. This is due to the substandard asciidoc support on Github. You should switch to http://erlang.mk for reading the documentation (links are broken THERE because of a change I did yesterday, I am fixing it now and this will break github). |
OK, so what about using a minimal Wiki on github with links to http://erlang.mk , instead ? And a simple cheat sheet in README.md like #370 is proposing may be good. MHO |
I precise my thoughts : wiki on github for experimental/master features and a link to http://erlang.mk for things written in marble / official stable documentation. |
There's no difference between master and stable in this project. Documenting experimental features on the wiki would still make them documented and that's not something we want. There's very little of those anyway. Finally there's already a link to erlang.mk at the top of the repository and to the guide in the README. |
Ah, I see, README is still old links. |
yes, this is why people, like me, are looking at documentation in github instead of http://erlang.mk |
cheat sheet would be nice anyway, and a heading global link to http://erlang.mk documentation would be sufficient , instead many 'Check out our upcoming user guide!' ... but a personal feeling. |
The documentation is slowly phasing out the old README, which explains why things are the way they are now. But it should be time to rework it now. I will do it today. A cheat sheet would be nice, and will be added at some point. |
fix #467