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

Fix invalid link to documentation #468

Merged
merged 1 commit into from
Dec 30, 2015

Conversation

crownedgrouse
Copy link
Contributor

fix #467

@essen essen merged commit 39eb23f into ninenines:master Dec 30, 2015
@essen
Copy link
Member

essen commented Dec 30, 2015

Merged, thanks!

@essen
Copy link
Member

essen commented Dec 30, 2015

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).

@crownedgrouse
Copy link
Contributor Author

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

@crownedgrouse crownedgrouse deleted the app_asciidoc branch December 30, 2015 08:40
@crownedgrouse
Copy link
Contributor Author

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.

@essen
Copy link
Member

essen commented Dec 30, 2015

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.

@essen
Copy link
Member

essen commented Dec 30, 2015

Ah, I see, README is still old links.

@crownedgrouse
Copy link
Contributor Author

yes, this is why people, like me, are looking at documentation in github instead of http://erlang.mk

@crownedgrouse
Copy link
Contributor Author

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.

@essen
Copy link
Member

essen commented Dec 30, 2015

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. make help is the best alternative for now.

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

Successfully merging this pull request may close these issues.

Missing link in app.asciidoc
2 participants