You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
README.md should only reflect the released version #402
As an alternative we could create a specific PR, which will get merged after the new version is released. That might be better, because with an open PR we can just merge it without having to deal with conflicts manually.
My problems with the specific branch is that if some one works on "branch A" to add Foo support they really should document it as they go. But now they need to go to another branch to make the documentation.
Also the ability to have "compileable" readme examples is low with this approach since they need to be maintained across 2 branches
Yeah maybe having a "how to use graphql" .md file would be more easy to manage from a version point of view. The current system would always stay stable.
Activity
andimarek commentedon May 2, 2017
As an alternative we could create a specific PR, which will get merged after the new version is released. That might be better, because with an open PR we can just merge it without having to deal with conflicts manually.
graphql-java#402 - put a next version README in place
bbakerman commentedon May 4, 2017
My problems with the specific branch is that if some one works on "branch A" to add Foo support they really should document it as they go. But now they need to go to another branch to make the documentation.
Also the ability to have "compileable" readme examples is low with this approach since they need to be maintained across 2 branches
Merge pull request #403 from bbakerman/402-latest-readme-support
cliedeman commentedon May 4, 2017
React router solves this problem nicely by having links to docs of the previous versions right at the top of the readme.
bbakerman commentedon May 6, 2017
Yeah maybe having a "how to use graphql" .md file would be more easy to manage from a version point of view. The current system would always stay stable.
andimarek commentedon May 20, 2017
switched to readthedocs.io and they support different versions.
Merge remote-tracking branch 'upstream/master'