Implement enhanced LLM documentation endpoints with proper formatting #2259
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR implements two new endpoints for LLM documentation generation as specified in the requirements:
✅ 1. Enhanced
/docs/llms.txt
— Lightweight documentation indexUpdated the existing endpoint to provide a structured, lightweight overview of documentation pages intended for fast reference and LLM metadata indexing.
Features:
title
field or first-level heading#
description
field or first paragraphhttps://appwrite.io/docs/products/auth/email-password
)Example output:
✅ 2. New
/docs/llms-full.txt
— Complete markdown dumpAdded a new endpoint that provides a raw dump of all documentation content for LLM ingestion.
Features:
\n\n---\n\n
)Processing Results:
Technical Implementation
Both endpoints use SvelteKit's
import.meta.glob
to dynamically process all+page.markdoc
files in the/docs
directory. The implementation includes:The endpoints are pre-rendered at build time and will automatically update whenever documentation content changes.
Warning
Firewall rules blocked me from connecting to one or more addresses
I tried to connect to the following addresses, but was blocked by firewall rules:
https://api.github.com/repos/appwrite/appwrite/contributors
node ./scripts/build.js
(http block)https://api.github.com/repos/appwrite/console/contributors
node ./scripts/build.js
(http block)https://api.github.com/repos/appwrite/sdk-generator/contributors
node ./scripts/build.js
(http block)If you need me to access, download, or install something from one of these locations, you can either:
💬 Share your feedback on Copilot coding agent for the chance to win a $200 gift card! Click here to start the survey.