elixir-mix-otp-guide icon indicating copy to clipboard operation
elixir-mix-otp-guide copied to clipboard

Worthy project. What happens when the docs change?

Open vonHabsi opened this issue 4 years ago • 3 comments

This project is a worthy one.

What happens when Introduction to Mix - Elixir changes?

I think you should make a note of the commit or range of commits of Introduction to Mix - Elixir this project based is based on, or else it will go out of date like a lot of the tutorials out there.

vonHabsi avatar Oct 23 '19 10:10 vonHabsi

What happens when Introduction to Mix - Elixir changes?

Thats a great idea!

I'll be keeping a look or perhaps add some alert to whenever a change occurs in the documentation to reflect that on the repository.

I think you should make a note of the commit or range of commits of Introduction to Mix - Elixir

Yep - Changing the way README is structured: it could simply be formatted in a way that reflects the different commits for different updates in the documentation.

For now - I believe its premature optimization and if such a situation occur when they do a major update at their documentation, I'll try my best to reflect a new setup in the repository.

If you have any views over the solution, I am super eager to hear. :)

SlapBot avatar Oct 23 '19 10:10 SlapBot

I don't think the documentation will change that much, but if some people get problems due to changes it will be useful for them to know the version of the documentation that the code here is compatible with.

vonHabsi avatar Oct 23 '19 15:10 vonHabsi

Good idea, However - It seems elixir guide is not being versioned explicitly: https://github.com/elixir-lang/elixir-lang.github.com/tree/master/getting-started

Maybe setting the tone of which version of elixir lang its compatible with could be a step in correct direction.

SlapBot avatar Oct 24 '19 02:10 SlapBot