Skip to content

Commit 833ba88

Browse files
authored
feat(docs): add llms.txt generation and the Context7 configuration (#109)
1 parent 0efb17a commit 833ba88

4 files changed

Lines changed: 121 additions & 1 deletion

File tree

apps/docs/astro.config.mjs

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
// @ts-check
22
import starlight from '@astrojs/starlight';
33
import { defineConfig } from 'astro/config';
4+
import starlightLlmsTxt from 'starlight-llms-txt';
45
import { AVAILABLE_PACKAGES } from './src/package-registry';
56

67
export default defineConfig({
@@ -15,6 +16,8 @@ export default defineConfig({
1516
},
1617
description:
1718
'Phone number parsing, validation, formatting, and a headless input controller for JavaScript and TypeScript. Verified against Google libphonenumber.',
19+
// llms.txt, llms-full.txt, and llms-small.txt for AI assistant retrieval.
20+
plugins: [starlightLlmsTxt()],
1821
favicon: '/favicon.svg',
1922
social: [{ icon: 'github', label: 'GitHub', href: 'https://github.com/martsinlabs/telixon' }],
2023
editLink: { baseUrl: 'https://github.com/martsinlabs/telixon/edit/main/apps/docs/' },

apps/docs/package.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,8 @@
1515
"@telixon/core": "workspace:*",
1616
"@telixon/web-sdk": "workspace:*",
1717
"astro": "^7.0.5",
18-
"sharp": "^0.35.3"
18+
"sharp": "^0.35.3",
19+
"starlight-llms-txt": "^0.11.0"
1920
},
2021
"devDependencies": {
2122
"@astrojs/check": "^0.9.9",

context7.json

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
{
2+
"$schema": "https://context7.com/schema/context7.json",
3+
"projectTitle": "Telixon",
4+
"description": "Phone number parsing, validation, formatting, and a headless input controller for JavaScript and TypeScript. Verified against Google libphonenumber.",
5+
"folders": ["apps/docs/src/content/docs", "packages/core", "packages/web-sdk"],
6+
"excludeFolders": [
7+
"packages/core/src",
8+
"packages/core/dist",
9+
"packages/core/oracle",
10+
"packages/core/bench",
11+
"packages/core/conformance",
12+
"packages/web-sdk/src",
13+
"packages/web-sdk/dist"
14+
],
15+
"excludeFiles": ["CHANGELOG.md"],
16+
"rules": [
17+
"Telixon is a standalone library with its own engine compiled from Google libphonenumber metadata; it has no runtime dependency on any other phone number library.",
18+
"Initialize the engine with ensureEngineReady before calling parse or controller APIs; ensureEngineReadySync from @telixon/core/sync-init is the synchronous entry.",
19+
"Use @telixon/core for parsing, formatting, and validation; use @telixon/web-sdk to attach the input controller to a DOM input element.",
20+
"The full documentation lives at https://telixon.dev and the conformance dashboards at https://proof.telixon.dev."
21+
]
22+
}

pnpm-lock.yaml

Lines changed: 94 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)