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

docs: overhaul README #1954

Merged
merged 13 commits into from
Mar 16, 2022
Merged

docs: overhaul README #1954

merged 13 commits into from
Mar 16, 2022

Conversation

davidjgoss
Copy link
Contributor

🤔 What's changed?

Overhaul of the README. For convenience, view it here: https://github.com/cucumber/cucumber-js/tree/revamped-readme

Specifically:

  • Simple logo, title and tagline
  • Add a badge showing latest version on npm
  • Remove the dependencies badge which didn't work
  • Add a basic "get started" example
  • Condense and refactor various parts so users get to the "get started" quicker
  • Make some of the documentation links a bit more helpful
  • Move links to older versions docs to a separate file

Also links to a new demo using CodeSandbox, since the old-browser demo doesn't reflect the current version and can't be reimplemented with it.

⚡️ What's your motivation?

See cucumber/common#1521 (comment). More informative and welcoming to new users.

🏷️ What kind of change is this?

  • 🏦 Refactoring/debt (improvement to code design or tooling without changing behaviour)

📋 Checklist:

  • I agree to respect and uphold the Cucumber Community Code of Conduct
  • I've changed the behaviour of the code
    • I have added/updated tests to cover my changes.
  • My change requires a change to the documentation.
    • I have updated the documentation accordingly.
  • Users should know about my change
    • I have added an entry to the "Unreleased" section of the CHANGELOG, linking to this pull request.

@davidjgoss davidjgoss added the 📖 documentation Improvements or additions to documentation label Mar 16, 2022
@davidjgoss davidjgoss changed the title Revamped readme docs: overhaul README Mar 16, 2022
@coveralls
Copy link

Coverage Status

Coverage remained the same at 98.266% when pulling f97f3ed on revamped-readme into 7326ae5 on main.

Copy link
Contributor

@aurelien-reeves aurelien-reeves left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Love it 🤩😍

@davidjgoss davidjgoss merged commit 3d2598e into main Mar 16, 2022
@davidjgoss davidjgoss deleted the revamped-readme branch March 16, 2022 10:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📖 documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants