[doc] Add Fast-LLM Social Media Cards

[tscholak]

🤨 Problem Description

Currently, the Fast-LLM repository lacks a customized social media preview. This means that when repository links are shared on social platforms, they only display basic information, such as the ServiceNow's name and image avatar (currently the NOW icon). This can make the project less visually distinctive and reduce its recognizability and engagement on platforms like LinkedIn, X (formerly Twitter), and Facebook.

💡 Proposed Solution

Add a customized social media preview image for the Fast-LLM repository. Let's do this in the following two complementary ways:

1. GitHub Repository Social Media Preview:

   • Use the provided template from GitHub's documentation (link) to create an image sized at 1280x640 pixels. This image should feature the Fast-LLM logo and main selling points, including SPEEEEEED!
   • Navigate to the repository settings on GitHub.
   • Under the "Social preview" section, upload a custom image that will serve as the social media preview.
   • Once enabled, this image will be shown whenever someone links to https://github.com/ServiceNow/Fast-LLM on social platforms.

2. MkDocs Material Social Cards Plugin:

   • Enable the built-in social plugin in mkdocs.yml by adding the following:

     plugins:
       - social
     site_url: https://example.com  # Replace with the actual repository site URL

   • Configure default card layouts and add custom titles/descriptions using front matter in the documentation.
   • Once enabled, this will the link previews to Fast-LLM's documentation on social platforms.

🔄 Alternatives Considered

1. Do Nothing:
   • While this would require no additional effort, it does not address the lack of branding or visual appeal when sharing links on social media, reducing potential engagement.

📈 Potential Benefits

1. Enhanced Branding:

   • A visually distinctive preview image ensures that Fast-LLM stands out when shared on social platforms, strengthening brand recognition.

2. Improved Engagement:

   • Eye-catching previews increase the likelihood of users clicking on the shared links, potentially driving more traffic to the repository and documentation.

3. Professional Presentation:

   • Custom previews give an impression of attention to detail and professionalism, which can positively influence perceptions of the project.

4. Automated Updates for Documentation:

   • With MkDocs Material, social cards can be dynamically generated and updated for each documentation page, ensuring consistency and reducing manual effort.

📝 Additional Context

• GitHub’s documentation on customizing social media previews: link
• MkDocs Material documentation on social cards: link

Image Template Example: