Inform user about deprecated doc
Nobody has claimed this yet.
- Dominant language
- SCSS
- Stars
- 15
- Forks
- 41
- Avg merge
- 4m
- Merged PRs (30d)
- 1
Description
Hello
When searching RSpec documentation online. I often end up on a page documentation of RSpec gems bellow 2.99.
I was thinking about the best way to mark our doc as deprecated. Few ideas:
- Add a block to tell the reader that he/she is not on the last version with an easy link to jump to current. We can see this on PostgreSQL
-
Maybe too powerful... Disable search engine indexing on old version? The best should be to change the SEO but I do not have those magic capabilities.
-
Set a new documentation for RSpec 4? VCR had a discussion.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
The issue names no files, tests, or entry points; start by locating the versioned documentation and its search or indexing configuration in rspec.github.io. Compare the proposed PostgreSQL-style notice with the linked VCR discussion, then define and implement one accepted approach for old RSpec versions.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- ruby, scss
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100