Skip to content

README.md should only reflect the released version #402

Closed

Description

@bbakerman

The master branch contains new code that is not released.

However people come to the "home" README to find out how to use the released library

And with 3.x, its breaking changes.

We need a way to stage future READMEs text while not breaking current examples

I propose we keep a README.next.md so we can stage future work progressively yet retain the old released examples

Activity

  1. andimarek commented on May 2, 2017

    @andimarek
    Member

    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.

  2. added a commit that references this issue on May 2, 2017
  3. bbakerman commented on May 4, 2017

    @bbakerman
    MemberAuthor

    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

  4. added a commit that references this issue on May 4, 2017
  5. cliedeman commented on May 4, 2017

    @cliedeman

    React router solves this problem nicely by having links to docs of the previous versions right at the top of the readme.

  6. bbakerman commented on May 6, 2017

    @bbakerman
    MemberAuthor

    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.

  7. andimarek commented on May 20, 2017

    @andimarek
    Member

    switched to readthedocs.io and they support different versions.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions