Skip to content

Rework docs: separate rarely used features into "legacy" section

gitlab-qa-bot requested to merge github/fork/e2/rework-docs-separate-rarely-used into master

Created by: e2

As suggested here: https://github.com/rspec/rspec-core/issues/2252#issuecomment-223825782 , I'll keep changes small for easier reviewing.

For now, I suggest moving rspec mocks and expectations related features into "legacy & special needs projects" section - to remove the "clutter" on the main index.

What I'm not sure about:

  1. Aggregate failures is not a legacy feature, and even though it relies on the expectation framework, it should be just mentioned in it's description that it requires rspec expectations to work
  2. I don't like the section name, so I'm open to all sorts of suggestions. New users aren't likely to go crazy trying to use everything except rspec-mocks and rspec-expectations, that's why I called them "special-needs projects".
  3. "Alias example" is probably rarely used since things like fit and xit are now available easily without configuration. These should probably be provided by plugins, just like rspec-rails does with feature specs.
  4. "use any framework" should be renamed to "user any mock framework".

Merge request reports