Skip to content

Commit 191d3b8

Browse files
fratzingerclaude
andcommitted
docs: add feathers-utils successor notice
Point users to feathers-utils as the successor of feathers-hooks-common, via a callout in the README and a site-wide banner in the VitePress docs. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
1 parent d727cdb commit 191d3b8

3 files changed

Lines changed: 81 additions & 0 deletions

File tree

‎README.md‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,14 @@
1313

1414
A collection of useful hooks to use with Feathers services.
1515

16+
> [!IMPORTANT]
17+
> **feathers-hooks-common has a successor: [feathers-utils](https://utils.feathersjs.com/)**
18+
>
19+
> `feathers-utils` provides a modern and improved set of hooks and utilities for FeathersJS applications. New projects should use it instead of `feathers-hooks-common`.
20+
>
21+
> - Documentation: [utils.feathersjs.com](https://utils.feathersjs.com/)
22+
> - GitHub: [feathersjs/feathers-utils](https://github.com/feathersjs/feathers-utils)
23+
1624
> NOTE: This is the version for Feathers v5. For Feathers v4 use [feathers-hooks-common v6](https://github.com/feathersjs-ecosystem/feathers-hooks-common/tree/crow)
1725
1826
```
Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
<template>
2+
<div class="successor-banner">
3+
<p>
4+
<strong>feathers-hooks-common</strong> has a successor:
5+
<a href="https://utils.feathersjs.com/">feathers-utils</a>.
6+
<span class="successor-banner-long">Check out the new docs for a modern, improved set of hooks and utilities.</span>
7+
</p>
8+
</div>
9+
</template>
10+
11+
<style>
12+
:root {
13+
--vp-layout-top-height: 48px;
14+
}
15+
16+
@media (min-width: 768px) {
17+
:root {
18+
--vp-layout-top-height: 40px;
19+
}
20+
}
21+
</style>
22+
23+
<style scoped>
24+
.successor-banner {
25+
position: fixed;
26+
top: 0;
27+
right: 0;
28+
left: 0;
29+
z-index: var(--vp-z-index-layout-top);
30+
display: flex;
31+
align-items: center;
32+
justify-content: center;
33+
height: var(--vp-layout-top-height);
34+
padding: 0 16px;
35+
background-color: var(--vp-c-brand);
36+
color: #fff;
37+
font-size: 14px;
38+
line-height: 1.3;
39+
text-align: center;
40+
}
41+
42+
.successor-banner p {
43+
margin: 0;
44+
}
45+
46+
.successor-banner a {
47+
color: inherit;
48+
font-weight: 600;
49+
text-decoration: underline;
50+
text-underline-offset: 2px;
51+
}
52+
53+
.successor-banner a:hover {
54+
opacity: 0.85;
55+
}
56+
57+
.successor-banner-long {
58+
display: none;
59+
}
60+
61+
@media (min-width: 768px) {
62+
.successor-banner-long {
63+
display: inline;
64+
}
65+
}
66+
</style>

‎docs/.vitepress/theme/index.ts‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,13 @@
1+
import { h } from 'vue'
12
import Theme from 'vitepress/theme'
3+
import SuccessorBanner from './SuccessorBanner.vue'
24
import '../style/main.css'
35

46
export default {
57
...Theme,
8+
Layout() {
9+
return h(Theme.Layout, null, {
10+
'layout-top': () => h(SuccessorBanner),
11+
})
12+
},
613
}

0 commit comments

Comments
 (0)