Skip to content

API Documentation Updates and Style Enhancements πŸš€ #18

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 5 commits into
base: main
Choose a base branch
from

Conversation

madhurimarawat
Copy link
Collaborator

  • Added new APIs Documentation to the collection for developers, including:

    • πŸ“š Books API – Access comprehensive book data
    • πŸŽ₯ Movies API – Explore movies, genres, ratings, and more
    • πŸ‘₯ Users API – Fetch realistic user data
    • 🍽️ Recipes API – Find recipes with ingredients and nutrition facts
    • πŸ’¬ Quotes API – Access motivational and inspirational quotes
    • 🀣 Jokes API – Retrieve funny jokes
    • πŸ’» Programming Jokes API – Get nerdy programming humor
    • πŸ› οΈ More APIs Coming Soon – Exciting updates to follow!
  • API Documentation:

    • Detailed documentation added for all APIs
    • Links to documentation in both HTML and PDF formats via GitHub πŸ“„
  • Style Enhancements:

    • Updated the gradient color for the hero section in globals.css 🎨

      • Changed color from #60efff to #54d9ec for a more vibrant and readable design
    • Responsive cards added to docs.css to improve layout and UX

Updated section:

.hero-section {
  padding: 100px 0;
  /* Top and bottom padding to create vertical space */

  /* Background gradient for the hero area */
  background: linear-gradient(135deg, #0061ff 0%, #54d9ec 100%);

  position: relative;
  /* Allows the ::before pseudo-element to be positioned absolutely */
  overflow: hidden;
  /* Ensures SVG pattern does not overflow */
}
  • Preview Images & Meta Tags:

    • 🎯 Added preview images (api-docs-preview.webp and contact-preview.webp) for better SEO and page preview for the docs and contact pages
    • Updated meta tags for docs.html and contact.html pages for better search engine optimization (SEO)
  • Files Updated:

    • globals.css – Gradient color updates
    • docs.html – API documentation and preview images
    • contact.html – Contact page meta tags and preview images
    • api/docs/ – New API documentation added
    • docs.css – Responsive design for API cards
    • Assets Folder – Added api-docs-preview.webp and contact-preview.webp

To understand the structure of docs in detail visit:

PR: #16
Issue: #2

For SEO meta tags detail visit:

Issue: #3

@madhurimarawat madhurimarawat self-assigned this May 7, 2025
@madhurimarawat madhurimarawat added documentation Improvements or additions to documentation enhancement New feature or request labels May 7, 2025
Copy link

netlify bot commented May 7, 2025

βœ… Deploy Preview for aqua-script ready!

Name Link
πŸ”¨ Latest commit 66fa679
πŸ” Latest deploy log https://app.netlify.com/sites/aqua-script/deploys/681b27360dbdf300083af5e0
😎 Deploy Preview https://deploy-preview-18--aqua-script.netlify.app
πŸ“± Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link

vercel bot commented May 7, 2025

The latest updates on your projects. Learn more about Vercel for Git β†—οΈŽ

Name Status Preview Comments Updated (UTC)
aquascript βœ… Ready (Inspect) Visit Preview πŸ’¬ Add feedback May 7, 2025 9:26am

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant