Skip to content

docs: add .agents/skills/axios-cache-interceptor.md and AI install guide#1212

Merged
arthurfiorette merged 3 commits intomainfrom
copilot/create-axios-cache-interceptor-skill
Mar 16, 2026
Merged

docs: add .agents/skills/axios-cache-interceptor.md and AI install guide#1212
arthurfiorette merged 3 commits intomainfrom
copilot/create-axios-cache-interceptor-skill

Conversation

Copy link
Contributor

Copilot AI commented Mar 16, 2026

Adds a concise, scannable skill reference for AI coding assistants at .agents/skills/axios-cache-interceptor.md, and documents how to install it in the getting started guide.

What's included

  • SetupsetupCache() with request deduplication example
  • Response shapeid, cached, stale fields
  • Global & per-request configttl, enabled, cachePredicate, staleIfError, hydrate, override, etag, vary
  • Cache invalidationcache.update (delete + programmatic update), storage.remove/clear
  • Storage backends — memory, localStorage/sessionStorage, custom via buildStorage (Redis example included)
  • HTTP standards — ETag/If-None-Match, Vary, Cache-Control/Expires header behaviour table
  • Key generation — custom IDs, SHA-256 generator for persistent caches exceeding 77,000 unique keys
  • Debugging — dev build import + debug callback
  • TypeScript types — key named imports
  • Common patterns — singleton, opt-in caching, post-mutation invalidation, persistent browser cache
  • llms.txt linkhttps://axios-cache-interceptor.js.org/llms.txt added to skill header so AI tools can crawl the full documentation
  • AI / LLM Skills section — added to docs/src/guide/getting-started.md documenting npx skills add axios-cache-interceptor via the Skills framework

📍 Connect Copilot coding agent with Jira, Azure Boards or Linear to delegate work to Copilot in one click without leaving your project management tool.

Co-authored-by: arthurfiorette <47537704+arthurfiorette@users.noreply.github.com>
Copilot AI changed the title [WIP] Add axios-cache-interceptor skill documentation docs: add .agents/skills/axios-cache-interceptor.md Mar 16, 2026
Copilot AI requested a review from arthurfiorette March 16, 2026 15:30
Copy link
Owner

@arthurfiorette arthurfiorette left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you document on our install guide that we have skills that can be installed using https://github.com/vercel-labs/skills? Also put in the skill a link to our https://axios-cache-interceptor.js.org/llms.txt AIs can use to crawl.

Co-authored-by: arthurfiorette <47537704+arthurfiorette@users.noreply.github.com>
Copy link
Contributor Author

Copilot AI commented Mar 16, 2026

Can you document on our install guide that we have skills that can be installed using https://github.com/vercel-labs/skills? Also put in the skill a link to our https://axios-cache-interceptor.js.org/...

Done in a7045eb:

  • Added https://axios-cache-interceptor.js.org/llms.txt to the skill file's header metadata so AI tools can crawl the full docs.
  • Added an "AI / LLM Skills" section to docs/src/guide/getting-started.md documenting npx skills add axios-cache-interceptor (via the Skills framework).

Copilot AI changed the title docs: add .agents/skills/axios-cache-interceptor.md docs: add .agents/skills/axios-cache-interceptor.md and AI install guide Mar 16, 2026
Copilot AI requested a review from arthurfiorette March 16, 2026 16:24
@arthurfiorette arthurfiorette marked this pull request as ready for review March 16, 2026 16:57
Copilot AI review requested due to automatic review settings March 16, 2026 16:57
@arthurfiorette arthurfiorette merged commit 0f06a04 into main Mar 16, 2026
4 checks passed
@codecov
Copy link

codecov bot commented Mar 16, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 98.77%. Comparing base (ca3a099) to head (a7045eb).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1212   +/-   ##
=======================================
  Coverage   98.77%   98.77%           
=======================================
  Files          20       20           
  Lines        3113     3113           
  Branches      299      299           
=======================================
  Hits         3075     3075           
  Misses         37       37           
  Partials        1        1           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Adds an “AI / LLM Skills” entry point to the Getting Started guide and introduces a Skills-framework markdown “skill” document intended to give AI assistants a curated, up-to-date reference for axios-cache-interceptor.

Changes:

  • Document a new “AI / LLM Skills” section in the Getting Started guide with an npx skills add ... install command.
  • Add a new .agents/skills/axios-cache-interceptor.md skill file containing usage patterns, configuration reference, and examples.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.

File Description
docs/src/guide/getting-started.md Adds documentation for installing an AI/LLM “skill” for this library
.agents/skills/axios-cache-interceptor.md Introduces a comprehensive skill doc with examples and configuration guidance

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

You can also share your feedback on Copilot code review. Take the survey.

Comment on lines +135 to +139
## AI / LLM Skills

If you are using an AI coding assistant, you can install the axios-cache-interceptor skill
to give it up-to-date context about this library:

Comment on lines +284 to +292
set(key, value, req) {
const ttlMs =
value.state === 'loading'
? (req?.cache && typeof req.cache.ttl === 'number' ? req.cache.ttl : 60_000)
: (value.state === 'stale' && value.ttl) || (value.state === 'cached' && !canStale(value))
? value.createdAt + value.ttl!
: Date.now() + 60 * 60_000;

return client.set(`cache:${key}`, JSON.stringify(value), { PXAT: ttlMs });
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants