From 35a153041e0d559b6ec9fa8e5070173850a8b5e5 Mon Sep 17 00:00:00 2001 From: Jaime Cernuda Date: Tue, 29 Jul 2025 16:23:01 -0500 Subject: [PATCH] fix: Add social sharing metadata and simplified development section - Added enhanced OpenGraph and Twitter meta tags for IOWarp branding - Created dedicated social sharing image using IOWarp logo - Added simplified Development & Publishing section to README - Ensures IOWarp branding appears in social media and chat applications --- README.md | 18 ++++++++++++++++++ docs/docusaurus.config.js | 18 ++++++++++++++++-- docs/static/img/iowarp_logo.png | 1 + docs/static/img/iowarp_social_card.png | 1 + 4 files changed, 36 insertions(+), 2 deletions(-) create mode 100644 docs/static/img/iowarp_logo.png create mode 100644 docs/static/img/iowarp_social_card.png diff --git a/README.md b/README.md index 34ba5314..43997d71 100644 --- a/README.md +++ b/README.md @@ -86,6 +86,24 @@ uvx iowarp-mcps slurm NSF Logo **[NSF (National Science Foundation)](https://www.nsf.gov/)** - Supporting scientific computing research and AI integration initiatives +## Development & Publishing + +### Testing Development Versions + +Development versions are automatically published to TestPyPI on every commit to main: + +```bash +# Install latest dev version from TestPyPI +uvx --index-url https://test.pypi.org/simple/ iowarp-mcps +``` + +### Creating Releases + +```bash +git tag v1.2.3 +git push origin v1.2.3 +``` + ## Contributing We welcome contributions in any form! diff --git a/docs/docusaurus.config.js b/docs/docusaurus.config.js index ffba4e3c..7c10c689 100644 --- a/docs/docusaurus.config.js +++ b/docs/docusaurus.config.js @@ -64,8 +64,22 @@ const config = { themeConfig: /** @type {import('@docusaurus/preset-classic').ThemeConfig} */ ({ - // Replace with your project's social card - image: 'img/logo.svg', + // Enhanced metadata for social sharing + metadata: [ + {name: 'description', content: 'Collection of Model Context Protocol (MCP) servers for scientific computing research. Enable AI agents to interact with data analysis tools, HPC resources, and research datasets.'}, + {name: 'keywords', content: 'MCP, Model Context Protocol, scientific computing, AI agents, data analysis, HPC, research, IOWarp'}, + {property: 'og:title', content: 'IOWarp MCPs - Scientific Computing Tools for AI'}, + {property: 'og:description', content: 'Collection of Model Context Protocol servers for scientific computing research.'}, + {property: 'og:image', content: 'https://iowarp.github.io/iowarp-mcps/img/iowarp_social_card.png'}, + {property: 'og:image:width', content: '400'}, + {property: 'og:image:height', content: '400'}, + {name: 'twitter:card', content: 'summary_large_image'}, + {name: 'twitter:title', content: 'IOWarp MCPs - Scientific Computing Tools for AI'}, + {name: 'twitter:description', content: 'Collection of Model Context Protocol servers for scientific computing research.'}, + {name: 'twitter:image', content: 'https://iowarp.github.io/iowarp-mcps/img/iowarp_social_card.png'}, + ], + // Social card for link previews + image: 'img/iowarp_social_card.png', navbar: { title: 'IOWarp MCPs', logo: { diff --git a/docs/static/img/iowarp_logo.png b/docs/static/img/iowarp_logo.png new file mode 100644 index 00000000..9db6d0d0 --- /dev/null +++ b/docs/static/img/iowarp_logo.png @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/docs/static/img/iowarp_social_card.png b/docs/static/img/iowarp_social_card.png new file mode 100644 index 00000000..9db6d0d0 --- /dev/null +++ b/docs/static/img/iowarp_social_card.png @@ -0,0 +1 @@ + \ No newline at end of file