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

Worthy project. What happens when the docs change? #1

Open
vonHabsi opened this issue Oct 23, 2019 · 3 comments
Open

Worthy project. What happens when the docs change? #1

vonHabsi opened this issue Oct 23, 2019 · 3 comments

Comments

@vonHabsi
Copy link

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.

@SlapBot
Copy link
Owner

SlapBot commented Oct 23, 2019

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

@vonHabsi
Copy link
Author

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.

@SlapBot
Copy link
Owner

SlapBot commented Oct 24, 2019

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.

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