Skip to content

feat(docs): generate server.txt reference and wire into www llms - #47782

Merged
mandarini merged 3 commits into
masterfrom
docs/server-llms-reference
Jul 10, 2026
Merged

feat(docs): generate server.txt reference and wire into www llms#47782
mandarini merged 3 commits into
masterfrom
docs/server-llms-reference

Conversation

@mandarini

@mandarini mandarini commented Jul 9, 2026

Copy link
Copy Markdown
Contributor

Add a server entry to the reference-markdown pipeline so it emits public/markdown/reference/server.md, and register the Supabase Server Library Reference as a source in the www llms.txt and llms-full.txt routes.

Summary by CodeRabbit

  • Documentation
    • Added the Supabase Server SDK Reference to the documentation set, including server-side API details.
    • Updated generated documentation outputs so the server reference appears in both the standard and plaintext documentation indexes/feeds.
    • Improved reference content rendering by enhancing how API descriptions are extracted and composed for more complete, readable SDK documentation.

@mandarini
mandarini requested review from a team as code owners July 9, 2026 14:00
@supabase

supabase Bot commented Jul 9, 2026

Copy link
Copy Markdown

This pull request has been ignored for the connected project xguihxuzqibwxjnimxev because there are no changes detected in supabase directory. You can change this behaviour in Project Integrations Settings ↗︎.


Preview Branches by Supabase.
Learn more about Supabase Branching ↗︎.

@vercel

vercel Bot commented Jul 9, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
docs Ready Ready Preview, Comment, Open in v0 Jul 10, 2026 10:34am
zone-www-dot-com Ready Ready Preview, Comment, Open in v0 Jul 10, 2026 10:34am
5 Skipped Deployments
Project Deployment Actions Updated (UTC)
studio Ignored Ignored Jul 10, 2026 10:34am
design-system Skipped Skipped Jul 10, 2026 10:34am
studio-self-hosted Skipped Skipped Jul 10, 2026 10:34am
studio-staging Skipped Skipped Jul 10, 2026 10:34am
ui-library Skipped Skipped Jul 10, 2026 10:34am

Request Review

@github-actions github-actions Bot added the documentation Improvements or additions to documentation label Jul 9, 2026
@mandarini mandarini self-assigned this Jul 9, 2026
@coderabbitai

coderabbitai Bot commented Jul 9, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 05992136-f8fe-4eb7-bca7-ec0b08852980

📥 Commits

Reviewing files that changed from the base of the PR and between cc5148c and 909cc1e.

📒 Files selected for processing (3)
  • apps/docs/internals/generate-reference-markdown.ts
  • apps/www/app/llms-full.txt/route.ts
  • apps/www/app/llms.txt/route.ts
🚧 Files skipped from review as they are similar to previous changes (3)
  • apps/www/app/llms.txt/route.ts
  • apps/www/app/llms-full.txt/route.ts
  • apps/docs/internals/generate-reference-markdown.ts

📝 Walkthrough

Walkthrough

The reference generator now produces server.md for the Supabase Server SDK Reference, with expanded TypeSpec comment handling. Both /llms-full.txt and /llms.txt include the new Server reference source.

Changes

Server reference publication

Layer / File(s) Summary
Generate Server reference markdown
apps/docs/internals/generate-reference-markdown.ts
Adds the Server reference target and updates renderSdkNew to resolve variable documentation and combine short and full comment text.
Publish Server reference through LLM routes
apps/www/app/llms-full.txt/route.ts, apps/www/app/llms.txt/route.ts
Adds the Server reference to the full-content response and source-link list.

Estimated code review effort: 2 (Simple) | ~10 minutes

Possibly related PRs

Suggested reviewers: jeremenichelli, ChrisChinchilla

🚥 Pre-merge checks | ✅ 3 | ❌ 2

❌ Failed checks (2 warnings)

Check name Status Explanation Resolution
Description check ⚠️ Warning The description is a single sentence and omits the required template sections for behavior, issues, and context. Rewrite it using the template: confirm CONTRIBUTING.md, state change type, current behavior, new behavior, linked issues, and additional context.
Docstring Coverage ⚠️ Warning Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. Write docstrings for the functions missing them to satisfy the coverage threshold.
✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title matches the main change: adding the server reference pipeline and wiring it into llms routes.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/server-llms-reference

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

Comment thread apps/www/app/llms.txt/route.ts Outdated
return [
...guideSources,
{ title: 'Supabase Reference (JavaScript)', relPath: 'llms/js.txt', enabled: true },
{ title: 'Supabase Server Library Reference', relPath: 'llms/server.txt', enabled: true },

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Just for the sake of consistency:

Suggested change
{ title: 'Supabase Server Library Reference', relPath: 'llms/server.txt', enabled: true },
{ title: 'Supabase Reference' (Server SDK), relPath: 'llms/server.txt', enabled: true },

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

I adjusted it only a bit, because consistently it's not a "Supabase Library" like Javascript, kotlin, dart, etc. It's a separate thing, so I changed it to 'Supabase Server SDK Reference' and put it above 'Supabase CLI Reference' to highlight the consistency there!

@jeremenichelli

Copy link
Copy Markdown
Contributor
Screenshot 2026-07-09 at 16 10 55

There are a lot of sections with empty content. Probably because we introduced a new type of definition and updated the build script for the json files but not the markdown generation one to support it @mandarini

@mandarini
mandarini force-pushed the docs/server-llms-reference branch from f521625 to 0fb9369 Compare July 10, 2026 08:58
@mandarini

Copy link
Copy Markdown
Contributor Author

@mandarini
mandarini requested a review from jeremenichelli July 10, 2026 09:20
@mandarini
mandarini enabled auto-merge (squash) July 10, 2026 10:25
Add a `server` entry to the reference-markdown pipeline so it emits
`public/markdown/reference/server.md`, and register the Supabase Server
Library Reference as a source in the www `llms.txt` and `llms-full.txt`
routes.
@mandarini
mandarini force-pushed the docs/server-llms-reference branch from cc5148c to 909cc1e Compare July 10, 2026 10:27
@mandarini
mandarini merged commit 373e917 into master Jul 10, 2026
37 checks passed
@mandarini
mandarini deleted the docs/server-llms-reference branch July 10, 2026 10:56
@github-actions

github-actions Bot commented Jul 10, 2026

Copy link
Copy Markdown
Contributor

Braintrust eval report

Assistant (master-1783681164)

Score Average Improvements Regressions
Knowledge Usage 94.3% (+7.000000000000001pp) 3 🟢 1 🔴
SQL Identifier Quoting 100% (+0pp) - -
SQL Validity 100% (+0pp) - -
Tool Usage 69.6% (-3pp) 1 🟢 2 🔴
Time_to_first_token 4.1tok (+0.47tok) 11 🟢 18 🔴
Llm_calls 2.85 (-0.1) 10 🟢 13 🔴
Tool_calls 3.2 (+0.06) 9 🟢 13 🔴
Errors 5.63 (+0.37) - 11 🔴
Llm_errors 0 (+0) - -
Tool_errors 0 (+0) - -
Prompt_tokens 27450.37tok (+3972.28tok) 10 🟢 17 🔴
Prompt_cached_tokens 7185.66tok (+253.06tok) 17 🟢 12 🔴
Prompt_cache_creation_tokens 0tok (+0tok) - -
Prompt_cache_creation_5m_tokens 0tok (+0tok) - -
Prompt_cache_creation_1h_tokens 0tok (+0tok) - -
Completion_tokens 623.87tok (+18.79tok) 13 🟢 16 🔴
Completion_reasoning_tokens 110.38tok (+5.67tok) 12 🟢 15 🔴
Total_tokens 28074.24tok (+3991.07tok) 11 🟢 18 🔴
Estimated_cost 0$ (+0$) 14 🟢 13 🔴
Duration 19.98s (+1.71s) 9 🟢 20 🔴
Llm_duration 13.32s (+1.14s) 9 🟢 20 🔴

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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants