Skip to content

Add llms-full.txt comprehensive API reference#15

Open
fantaJinMode wants to merge 1 commit intoLinkForty:mainfrom
fantaJinMode:add_llms_full
Open

Add llms-full.txt comprehensive API reference#15
fantaJinMode wants to merge 1 commit intoLinkForty:mainfrom
fantaJinMode:add_llms_full

Conversation

@fantaJinMode
Copy link
Contributor

Description

Adds llms-full.txt, a 2,100-line LLM-optimized full reference document for @linkforty/core. It covers every API endpoint, TypeScript type, configuration option, database schema, and integration pattern in a single, structured file designed for use with AI coding assistants.

Benefits

  • Enables AI tools to generate accurate, type-safe integration code without hallucinating API shapes
  • Single file covers the full surface area — no need to browse source or scattered docs
  • Complements the existing llms.txt (concise) / llms-full.txt (complete) convention

Type of Change

  • 🐛 Bug fix (non-breaking change which fixes an issue)
  • ✨ New feature (non-breaking change which adds functionality)
  • 💥 Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • 📝 Documentation update
  • ♻️ Code refactoring
  • ⚡ Performance improvement
  • ✅ Test addition or update

Changes Made

  • Added llms-full.txt with complete reference for the @linkforty/core package
  • Full API endpoint docs with request/response shapes for all routes (links, templates, analytics, webhooks, QR codes, mobile SDK, redirects)
  • All TypeScript types documented with field-level descriptions
  • Environment variable reference with defaults and descriptions
  • Database schema with table definitions and index explanations
  • Step-by-step redirect flow and fingerprint attribution algorithm
  • Integration patterns: self-hosted server, auth middleware, multi-tenant setup, React Native SDK, Node.js client
  • Performance tuning guidance (connection pooling, Redis caching, index reference)
  • Deployment checklist for Fly.io and general production environments

Testing

Successfully run npm run build without any errors.

  • Tests pass locally (npm test)
  • New tests added for new functionality
  • Existing tests updated (if needed)
  • Type checking passes (npm run typecheck)

Checklist

  • My code follows the project's code style
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings or errors
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • Any dependent changes have been merged and published
  • I have used conventional commit messages (e.g., feat:, fix:)
  • I have signed the Contributor License Agreement (the CLA bot will prompt you)

Breaking Changes

None

@CLAassistant
Copy link

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
You have signed the CLA already but the status is still pending? Let us recheck it.

@codecov
Copy link

codecov bot commented Mar 12, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

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.

2 participants