Merge pull request #2329 from hey-api/docs/community

docs: add community spotlight

Author: mrlubos

.github/workflows/contributors.yml

@@ -0,0 +1,30 @@
+name: Update Contributors
+
+on:
+  schedule:
+    - cron: '0 0 * * *' # Every day at 00:00 UTC
+  workflow_dispatch:
+
+jobs:
+  update:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/[email protected]
+
+      - name: Install dependencies
+        run: sudo apt-get update && sudo apt-get install -y jq curl
+
+      - name: Run update contributors script
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: |
+          chmod +x ./scripts/update-contributors.sh
+          ./scripts/update-contributors.sh
+
+      - name: Commit and push if updated
+        run: |
+          git config user.name "github-actions[bot]"
+          git config user.email "github-actions[bot]@users.noreply.github.com"
+          git add ./docs/partials/contributors-list.md
+          git diff --cached --quiet || git commit -m "chore(docs): update contributors list"
+          git push

.gitignore

@@ -1,4 +1,5 @@
 .DS_Store
+.cache
 .idea
 .tmp
 junit.xml

docs/.contributorsignore

@@ -0,0 +1,3 @@
+dependabot-preview[bot]
+dependabot[bot]
+github-actions[bot]

docs/.contributorssince

@@ -0,0 +1 @@
+2025-04-20T08:08:34Z

docs/.vitepress/config/en.ts

@@ -11,7 +11,7 @@ export default defineConfig({
     nav: [
       {
         link: 'https://github.com/sponsors/hey-api',
-        text: 'Sponsor Hey API 💰',
+        text: 'Sponsor Hey API',
       },
     ],
     sidebar: [
@@ -41,7 +41,7 @@ export default defineConfig({
             text: 'Configuration',
           },
         ],
-        text: '@hey-api/openapi-ts',
+        text: 'Introduction',
       },
       {
         items: [
@@ -229,6 +229,19 @@ export default defineConfig({
         ],
         text: 'Guides and Concepts',
       },
+      {
+        items: [
+          {
+            link: '/openapi-ts/community/spotlight',
+            text: 'Spotlight',
+          },
+          {
+            link: '/openapi-ts/community/contributing',
+            text: 'Contributing',
+          },
+        ],
+        text: 'Community',
+      },
       {
         items: [
           {
@@ -245,23 +258,15 @@ export default defineConfig({
             text: 'Migrating',
           },
           {
-            link: '/license',
+            link: '/openapi-ts/license',
             text: 'License',
           },
-          {
-            link: '/about',
-            text: 'Philosophy',
-          },
-          {
-            link: '/contributing',
-            text: 'Contributing',
-          },
           {
             link: 'https://github.com/orgs/hey-api/discussions/1495',
             text: 'Roadmap',
           },
         ],
-        text: '@hey-api',
+        text: '@hey-api/openapi-ts',
       },
     ],
   },

docs/.vitepress/theme/Layout.vue

@@ -29,7 +29,7 @@ const { Layout } = DefaultTheme;
         </a>
       </div> -->
     </template>
-    <template #home-features-before>
+    <!-- <template #home-features-before>
       <a
         aria-label="Send an email to Lubos"
         class="migration"
@@ -38,7 +38,7 @@ const { Layout } = DefaultTheme;
         <p>Migrate your existing TypeScript SDKs</p>
         <p>Contact us</p>
       </a>
-    </template>
+    </template> -->
   </Layout>
 </template>
 

docs/.vitepress/theme/custom.css

@@ -277,6 +277,11 @@ a.migration:focus {
   padding: 0.2rem 0;
 }
 
+.contributors-list ul {
+  margin-bottom: 1.3rem;
+  margin-top: 1.3rem;
+}
+
 @media (min-width: 640px) {
   .VPFeatures.VPHomeFeatures > .container > .items {
     gap: 1rem;
@@ -287,6 +292,10 @@ a.migration:focus {
   .sponsors-list > ul {
     flex-direction: row;
   }
+
+  .contributors-list ul {
+    columns: 2;
+  }
 }
 
 @media (min-width: 892px) {
@@ -309,3 +318,7 @@ a.migration:focus {
   padding: 0;
   width: 100%;
 }
+
+.VPNavBar.has-sidebar > .wrapper > .container > .title {
+  background-color: var(--vp-sidebar-bg-color);
+}

docs/about.md

@@ -0,0 +1,8 @@
+export const coreTeam = [
+  {
+    avatar: 'https://github.com/mrlubos.png',
+    links: [{ icon: 'github', link: 'https://github.com/mrlubos' }],
+    name: 'Lubos',
+    title: 'Hey API',
+  },
+];

docs/data/coreTeam.js

@@ -0,0 +1,20 @@
+export const hallOfFame = [
+  {
+    avatar: 'https://github.com/ferdikoomen.png',
+    links: [{ icon: 'github', link: 'https://github.com/ferdikoomen' }],
+    name: 'Ferdi Koomen',
+    title: 'OpenAPI TypeScript Codegen',
+  },
+  {
+    avatar: 'https://github.com/nicolas-chaulet.png',
+    links: [{ icon: 'github', link: 'https://github.com/nicolas-chaulet' }],
+    name: 'Nicolas Chaulet',
+    title: 'Made the Hey API fork',
+  },
+  {
+    avatar: 'https://github.com/jordanshatford.png',
+    links: [{ icon: 'github', link: 'https://github.com/jordanshatford' }],
+    name: 'Jordan Shatford',
+    title: 'Maintainer and Contributor',
+  },
+];